|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
Parameter
-interface.
See:
Description
Interface Summary | |
---|---|
Rangeable | Interface for Parameter s that potentially can be varied over a certain interval or a list of values. |
RangeIterator | Interface for a Parameter or ParameterSet that can have multiple values at the same
time. |
Class Summary | |
---|---|
ArrayParameterSet | Class for a ParameterSet that consists of a length-Parameter that defines the length
of the array and an array of ParameterSetContainer s of this length. |
CollectionParameter | Class for a collection parameter, i.e. a parameter that provides some collection of possible values the user can choose from. |
EnumParameter | This class implements a CollectionParameter based on an Enum. |
ExpandableParameterSet | A class for a ParameterSet that can be expanded by additional Parameter s at runtime. |
FileParameter | Class for a parameter that represents a local file. |
FileParameter.FileRepresentation | Class that represents a file |
InstanceParameterSet | Abstract class for a ParameterSet containing all parameters necessary to construct an
Object that implements InstantiableFromParameterSet . |
MultiSelectionCollectionParameter | Class for a Parameter that provides a collection of possible values. |
Parameter | Abstract class for a parameter that shall be used as the parameter of some method, constructor, etc. |
ParameterSet | (Container) class for a set of Parameter s. |
ParameterSetContainer | Class for a Parameter that contains a ParameterSet as value. |
RangeParameter | Class for a parameter wrapper that allows SimpleParameter s to be set to a set
of values. |
SimpleParameter | Class for a "simple" parameter. |
SimpleParameterSet | Class for a ParameterSet that is constructed from an array of Parameters
and thus does nothing in the loadParameters() -method. |
Enum Summary | |
---|---|
RangeParameter.RangeType | The possible types of defining ranges for a RangeParameter |
RangeParameter.Scale | The possible scales, if RangeParameter.RangeType is RangeParameter.RangeType.RANGE . |
Exception Summary | |
---|---|
ParameterException | Class for an exception that is thrown if some error occurs while setting a parameter's value or constructing a parameter. |
SimpleParameter.DatatypeNotValidException | Class for an Exception that can be thrown if the provided int -value
that represents a datatype is not one of the values defined in the Parameter -interface. |
SimpleParameter.IllegalValueException | This exception is thrown if a parameter is not valid. |
This package provides classes for parameters that establish a general convention for the description of parameters
as defined in the Parameter
-interface. This convention includes that each parameter has
ParameterValidator
that allows for a stricter validation, e.g. a specified range
of allowed parameter valuesString
s in SimpleParameter
, collections of
possible parameter values in CollectionParameter
, input files in FileParameter
, and
for parameters that can have a number of different parameter values in RangeParameter
.Parameter
-types can be combined to ParameterSet
s that contain a
set of Parameter
s. As SimpleParameter
s can also have ParameterSet
s
as values (the corresponding data type is DataType.PARAMETERSET
) and these can also be used
inside CollectionParameter
s, a tree of parameters can be built that allows to select between different
options in a collection and set the parameters that belong to the selected option, or to bundle sets of parameters
into subsets to allow for a clearer organization of parameters.
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |