de.fhstralsund.vinets.algorithm
Interface Configurator


public interface Configurator

Classes that implement this interface are able to generate values for a set of configuration options needed by a Configurable. The values for all options are stored in the Parameter object.


Method Summary
 void addBooleanOption(java.lang.String key, java.lang.Boolean def, java.lang.String label, java.lang.String hint)
          Called to add a boolean option.
 void addDoubleOption(java.lang.String key, java.lang.Double def, java.lang.Double min, java.lang.Double max, java.lang.String label, java.lang.String hint)
          Called to add an option with a double value.
 void addIntegerOption(java.lang.String key, java.lang.Integer def, java.lang.Integer min, java.lang.Integer max, java.lang.String label, java.lang.String hint)
          Called to add an option with an integer value.
 void addOption(de.fhstralsund.vinets.gui.options.Option opt)
          Called to add an Option.
 void addSelectOption(java.lang.String key, java.lang.Object def, java.lang.Object[] values, java.lang.String[] valueLabels, java.lang.String label, java.lang.String hint)
          Called to add a multiple choice option.
 void addTextOption(java.lang.String key, java.lang.String def, boolean empty, java.lang.String label, java.lang.String hint)
          Called to add a text option.
 Parameter getParameterObject()
          Returns a Parameter object with properties set to the configured values for the respective options.
 void subQuery(Configurable cfg)
           
 

Method Detail

addBooleanOption

void addBooleanOption(java.lang.String key,
                      java.lang.Boolean def,
                      java.lang.String label,
                      java.lang.String hint)
Called to add a boolean option.

Parameters:
key - a String used as key for the added option.
def - the default value.
label - a short description for this configuration option. It is used in the user interface.
hint - a longer description for this configuration option. This can be used in the user interface.

addIntegerOption

void addIntegerOption(java.lang.String key,
                      java.lang.Integer def,
                      java.lang.Integer min,
                      java.lang.Integer max,
                      java.lang.String label,
                      java.lang.String hint)
Called to add an option with an integer value.

Parameters:
key - a String used as key for the added option.
def - the default value.
min - the minimal value.
max - the maximal value.
label - a short description for this configuration option. It is used in the user interface.
hint - a longer description for this configuration option. This can be used in the user interface.

addDoubleOption

void addDoubleOption(java.lang.String key,
                     java.lang.Double def,
                     java.lang.Double min,
                     java.lang.Double max,
                     java.lang.String label,
                     java.lang.String hint)
Called to add an option with a double value.

Parameters:
key - a String used as key for the added option.
def - the default value.
min - the minimal value.
max - the maximal value.
label - a short description for this configuration option. It is used in the user interface.
hint - a longer description for this configuration option. This can be used in the user interface.

addSelectOption

void addSelectOption(java.lang.String key,
                     java.lang.Object def,
                     java.lang.Object[] values,
                     java.lang.String[] valueLabels,
                     java.lang.String label,
                     java.lang.String hint)
Called to add a multiple choice option.

Parameters:
key - a String used as key for the added option.
def - the default value.
values - an Object array containing the mutliple choice values.
valueLabels - a String array containing human readable names for the options.
label - a short description for this configuration option. It is used in the user interface.
hint - a longer description for this configuration option. This can be used in the user interface.

addTextOption

void addTextOption(java.lang.String key,
                   java.lang.String def,
                   boolean empty,
                   java.lang.String label,
                   java.lang.String hint)
Called to add a text option.

Parameters:
key - a String used as key for the added option.
def - the default value.
empty - indicates whether empty Strings are valid.
label - a short description for this configuration option. It is used in the user interface.
hint - a longer description for this configuration option. This can be used in the user interface.

addOption

void addOption(de.fhstralsund.vinets.gui.options.Option opt)
Called to add an Option.

Parameters:
opt - an Option object which contains a name as key for the corresponding value in the Parameter object.

getParameterObject

Parameter getParameterObject()
Returns a Parameter object with properties set to the configured values for the respective options.

Returns:
the Parameter object.

subQuery

void subQuery(Configurable cfg)