|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.jstacs.parameters.Parameter
de.jstacs.parameters.CollectionParameter
de.jstacs.parameters.MultiSelectionCollectionParameter
public class MultiSelectionCollectionParameter
Class for a Parameter
that provides a collection of possible values.
The user can select one or more values out of the collection as values of
this Parameter
.
CollectionParameter
Nested Class Summary |
---|
Nested classes/interfaces inherited from class de.jstacs.parameters.CollectionParameter |
---|
CollectionParameter.InconsistentCollectionException |
Field Summary |
---|
Fields inherited from class de.jstacs.parameters.CollectionParameter |
---|
errorMessage, parameters, userSelected |
Fields inherited from class de.jstacs.parameters.Parameter |
---|
neededReference, neededReferenceId, parent |
Constructor Summary | |
---|---|
|
MultiSelectionCollectionParameter(DataType datatype,
String[] keys,
Object[] values,
String[] comments,
String name,
String comment,
boolean required)
Constructor for a MultiSelectionCollectionParameter . |
|
MultiSelectionCollectionParameter(DataType datatype,
String[] keys,
Object[] values,
String name,
String comment,
boolean required)
Constructor for a MultiSelectionCollectionParameter . |
|
MultiSelectionCollectionParameter(InstanceParameterSet[] values,
String name,
String comment,
boolean required)
Creates a new MultiSelectionCollectionParameter from an array of
ParameterSet s. |
|
MultiSelectionCollectionParameter(ParameterSet[] values,
String[] keys,
String[] comments,
String name,
String comment,
boolean required)
Creates a new MultiSelectionCollectionParameter from an array of
ParameterSet s. |
protected |
MultiSelectionCollectionParameter(ParameterSet options,
boolean[] selected,
boolean[] defaultSelected,
boolean userSelected,
String name,
String comment,
boolean required,
DataType datatype,
String errorMessage,
int current,
boolean makeRanged)
Creates a new MultiSelectionCollectionParameter from the
necessary field. |
|
MultiSelectionCollectionParameter(StringBuffer representation)
The standard constructor for the interface Storable . |
Method Summary | |
---|---|
boolean |
checkValue(Object value)
Returns true if the key specified by value is
in the set of keys of this CollectionParameter . |
MultiSelectionCollectionParameter |
clone()
|
protected void |
fromXML(StringBuffer representation)
Parses a Parameter from a XML representation as returned by
Parameter.toXML() . |
int |
getNumberOfNexts(int afterIdx)
Returns the number of calls of next() that can be called
before false is returned. |
int |
getNumberOfValues()
Returns the number of values in the collection. |
int |
getSelected()
Returns the index of the selected value. |
Object |
getValue()
Returns the current value of this Parameter . |
Object |
getValueFor(int idx)
Returns the value of the option with no. |
Object |
getValueFor(String key)
Returns the value for the option with key key . |
Object[] |
getValues()
Returns the values of all selected options as an array. |
boolean |
hasDefaultOrIsSet()
Returns true if the parameter either has a default value or
the value was set by the user, false otherwise. |
boolean |
isAtomic()
Returns true if the parameter is of an atomic data type,
false otherwise. |
boolean |
isRanged()
Returns true if this RangeIterator is ranging over a
set of values. |
boolean |
isSelected(int idx)
Returns true if the option at position idx is
selected. |
boolean |
isSelected(String key)
Returns the selection value of the option with key key . |
boolean |
isSet()
Returns true if the parameter was set by the user,
false otherwise. |
boolean |
next()
Switches to the next value in the collection of values in the specified range. |
void |
reset()
Resets the parameter and its contents to the default values or null if no defaults are given. |
void |
resetToFirst()
Resets the current value in the collection to the first value. |
void |
setDefault(Object defaultValue)
Sets the default value of the Parameter to
defaultValue . |
boolean |
setSelected(int idx,
boolean selected)
Sets the selection of option with no. |
boolean |
setSelected(String key,
boolean selected)
Sets the selection of the option with key key to the value
of selected . |
void |
setValue(Object value)
Sets the selected value to the one that is specified by the key value . |
void |
simplify()
Simplifies the Parameter and its contents to the relevant
information. |
StringBuffer |
toXML()
This method returns an XML representation as StringBuffer of an
instance of the implementing class. |
String |
valuesToString()
Returns a String representation of the set of values. |
Methods inherited from class de.jstacs.parameters.CollectionParameter |
---|
appendCollection, createParameterSet, equals, extractCollection, fromGalaxy, getComment, getDatatype, getDefault, getErrorMessage, getName, getParametersInCollection, getRangedInstance, hasDefault, isRangeable, isRequired, isUserSelected, setRangeable, toGalaxy, toString |
Methods inherited from class de.jstacs.parameters.Parameter |
---|
getId, getNeededReference, getNeededReferenceId, getParent, setNeededReference, setParent |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MultiSelectionCollectionParameter(DataType datatype, String[] keys, Object[] values, String name, String comment, boolean required) throws CollectionParameter.InconsistentCollectionException, SimpleParameter.IllegalValueException, SimpleParameter.DatatypeNotValidException
MultiSelectionCollectionParameter
. The first
option in the selection is selected by default.
datatype
- the data type of the parameters in the collectionkeys
- the keys/names of the values in the collection, this is the
name the user will see in the user interfacevalues
- the values the names stand for, this array must be of the same
length as keys
, a key at a certain position
belongs to the value at the same position in the arrayname
- the name of the parametercomment
- a comment on the parameterrequired
- true
if the parameter is required,
false
otherwise
InconsistentCollectionException
- if the lengths of keys
and values
are different or the collection is inconsistent for some
other reason
SimpleParameter.IllegalValueException
- if one of the values in values
is not of type
datatype
SimpleParameter.DatatypeNotValidException
- if the datatype
is not one of the allowed values
CollectionParameter.InconsistentCollectionException
public MultiSelectionCollectionParameter(DataType datatype, String[] keys, Object[] values, String[] comments, String name, String comment, boolean required) throws CollectionParameter.InconsistentCollectionException, SimpleParameter.IllegalValueException, SimpleParameter.DatatypeNotValidException
MultiSelectionCollectionParameter
. The first
option in the selection is selected by default.
datatype
- the data type of the parameters in the collectionkeys
- the keys/names of the values in the collection, this is the
name the user will see in the user interfacevalues
- the values the names stand for, this array must be of the same
length as keys
, a key at a certain position
belongs to the value at the same position in the arraycomments
- the comments on the values in the collectionname
- the name of the parametercomment
- a comment on the parameterrequired
- true
if the parameter is required,
false
otherwise
InconsistentCollectionException
- if the lengths of keys
and values
are different or the collection is inconsistent for some
other reason
SimpleParameter.IllegalValueException
- if one of the values in values
is not of type
datatype
SimpleParameter.DatatypeNotValidException
- if the datatype
is not one of the allowed values
CollectionParameter.InconsistentCollectionException
public MultiSelectionCollectionParameter(ParameterSet[] values, String[] keys, String[] comments, String name, String comment, boolean required)
MultiSelectionCollectionParameter
from an array of
ParameterSet
s. The first option in the selection is selected by
default.
values
- the options/values in the collectionkeys
- the keys/names of the values in the collection, this is the
name the user will see in the user interfacecomments
- the comments on the possible valuesname
- the name of this MultiSelectionCollectionParameter
comment
- the comment on this MultiSelectionCollectionParameter
required
- true
if this
MultiSelectionCollectionParameter
is required,
false
otherwisepublic MultiSelectionCollectionParameter(InstanceParameterSet[] values, String name, String comment, boolean required)
MultiSelectionCollectionParameter
from an array of
ParameterSet
s. The first option in the selection is selected by
default.
values
- the options/values in the collectionname
- the name of this MultiSelectionCollectionParameter
comment
- the comment on this MultiSelectionCollectionParameter
required
- true
if this
MultiSelectionCollectionParameter
is required,
false
otherwisepublic MultiSelectionCollectionParameter(StringBuffer representation) throws NonParsableException
Storable
.
Creates a new MultiSelectionCollectionParameter
from its XML
representation
representation
- the XML representation as StringBuffer
NonParsableException
- if the StringBuffer
representation
could
not be parsedprotected MultiSelectionCollectionParameter(ParameterSet options, boolean[] selected, boolean[] defaultSelected, boolean userSelected, String name, String comment, boolean required, DataType datatype, String errorMessage, int current, boolean makeRanged) throws Exception
MultiSelectionCollectionParameter
from the
necessary field. This constructor should be used to clone a current
instance.
options
- the options of the CollectionParameter
selected
- the currently selected valuesdefaultSelected
- the values selected by defaultuserSelected
- true
if the current value was selected by the
user, false
name
- the name of the parametercomment
- a comment on the parameterrequired
- true
if this CollectionParameter
is
required, false
otherwisedatatype
- the data type of this CollectionParameter
errorMessage
- the error message of the last error or null
current
- the currently used value in the set of selected valuesmakeRanged
- replace the Parameter
in options
with
their ranged equivalent (if allowed)
Exception
- if something went wrongMethod Detail |
---|
public MultiSelectionCollectionParameter clone() throws CloneNotSupportedException
clone
in class CollectionParameter
CloneNotSupportedException
public boolean setSelected(String key, boolean selected)
key
to the value
of selected
.
key
- the key of the optionselected
- the selection value
true
if the key could be found and set,
false
otherwisepublic boolean isSelected(String key)
key
.
key
- the key of the option
false
if no such option
existspublic Object getValueFor(String key)
key
.
key
- the key of the option
null
if the corresponding option either
does not exist or is not selectedpublic boolean checkValue(Object value)
CollectionParameter
true
if the key specified by value
is
in the set of keys of this CollectionParameter
.
checkValue
in class CollectionParameter
value
- the value to be checked
true
if the key specified by value
is
in the set of keys of this CollectionParameter
,
false
otherwisepublic void setValue(Object value) throws SimpleParameter.IllegalValueException
CollectionParameter
value
.
setValue
in class CollectionParameter
value
- the key of the desired value
SimpleParameter.IllegalValueException
- if the specified value is not valid for this
Parameter
public int getSelected()
CollectionParameter
getSelected
in class CollectionParameter
public boolean setSelected(int idx, boolean selected)
idx
to
selected
.
idx
- the index of the optionselected
- the selection value
true
if the option exists and could be set,
false
otherwisepublic boolean isSelected(int idx)
CollectionParameter
true
if the option at position idx
is
selected.
isSelected
in class CollectionParameter
idx
- the position
true
if the option at position idx
is
selected, false
otherwisepublic Object getValueFor(int idx)
idx
.
idx
- the index of the option
null
if the corresponding option either
does not exists or is not selectedpublic Object[] getValues()
public Object getValue()
Parameter
Parameter
.
getValue
in class CollectionParameter
Parameter
public boolean hasDefaultOrIsSet()
Parameter
true
if the parameter either has a default value or
the value was set by the user, false
otherwise.
hasDefaultOrIsSet
in class CollectionParameter
true
if value has a default value or was set,
false
otherwisepublic boolean isSet()
Parameter
true
if the parameter was set by the user,
false
otherwise.
isSet
in class CollectionParameter
true
if the parameter was set, false
otherwisepublic boolean isAtomic()
Parameter
true
if the parameter is of an atomic data type,
false
otherwise.
isAtomic
in class CollectionParameter
true
if the parameter is atomic, false
otherwisepublic void simplify()
Parameter
Parameter
and its contents to the relevant
information. This could be e.g. to reset the contents of those values of
a CollectionParameter
that are not selected.
simplify
in class CollectionParameter
public void reset()
Parameter
null
if no defaults are given.
reset
in class CollectionParameter
public void setDefault(Object defaultValue) throws SimpleParameter.IllegalValueException
Parameter
Parameter
to
defaultValue
.
setDefault
in class CollectionParameter
defaultValue
- the default value
SimpleParameter.IllegalValueException
public StringBuffer toXML()
Storable
StringBuffer
of an
instance of the implementing class.
toXML
in interface Storable
toXML
in class CollectionParameter
protected void fromXML(StringBuffer representation) throws NonParsableException
Parameter
Parameter
from a XML representation as returned by
Parameter.toXML()
.
fromXML
in class CollectionParameter
representation
- the XML representation as StringBuffer
NonParsableException
- if the XML code could not be parsedParameter.toXML()
public boolean next() throws ParameterException
RangeIterator
next
in interface RangeIterator
true
if the next element exists, false
otherwise
ParameterException
- if the next value could not be fetchedpublic void resetToFirst()
RangeIterator
resetToFirst
in interface RangeIterator
public int getNumberOfValues()
RangeIterator
getNumberOfValues
in interface RangeIterator
public int getNumberOfNexts(int afterIdx)
next()
that can be called
before false
is returned.
afterIdx
- the index after which shall be counted
next()
public String valuesToString()
RangeIterator
String
representation of the set of values.
valuesToString
in interface RangeIterator
String
representationpublic boolean isRanged()
RangeIterator
true
if this RangeIterator
is ranging over a
set of values.
isRanged
in interface RangeIterator
true
if this RangeIterator
is ranging over a
set of values, false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |