de.jstacs.parameters
Class RangeParameter

java.lang.Object
  de.jstacs.parameters.Parameter
      de.jstacs.parameters.RangeParameter

All Implemented Interfaces:

GalaxyConvertible, RangeIterator, Storable, Cloneable

public class RangeParameter
extends Parameter
implements RangeIterator, GalaxyConvertible

Class for a parameter wrapper that allows SimpleParameters to be set to a set of values.
These values may be given either as a list of values separated by spaces, as a range between a first and a last value with a given number of steps between these values, or a single value. In the latter case a RangeParameter works just like a plain SimpleParameter. SimpleParameters that are used to construct a RangeParameter must be rangeable, i.e. their method SimpleParameter.isRangeable() must return true, or they will be rejected.

Author:

Jan Grau, Jens Keilwagen

Nested Class Summary

static class	RangeParameter.RangeType The possible types of defining ranges for a RangeParameter.
static class	RangeParameter.Scale This enum defines possible scales, if RangeParameter.RangeType is RangeParameter.RangeType.RANGE.

Field Summary

Fields inherited from class de.jstacs.parameters.Parameter

neededReference, neededReferenceId, parent

Constructor Summary

RangeParameter(SimpleParameter par)
Constructs a RangeParameter from a SimpleParameter that is rangeable.

RangeParameter(StringBuffer representation)
The standard constructor for the interface Storable.

Method Summary

boolean	checkValue(Object value) Checks the value for correctness, e.g. for numerical parameters this might be checking if the value is within specified bounds.
RangeParameter	clone()
void	fromGalaxy(String namePrefix, StringBuffer command) Parses the contents of command in the format defined by configBuffer of GalaxyConvertible.toGalaxy(String, String, int, StringBuffer, StringBuffer) and sets the values of the Parameter or ParameterSet accordingly.
protected void	fromXML(StringBuffer representation) Parses a Parameter from a XML representation as returned by Parameter.toXML().
static CollectionParameter	getCollectionOfScales() Returns a CollectionParameter that allows the user to choose between different scales.
String	getComment() Returns a comment on this Parameter that tells something about useful values, domains, usage of this parameter, etc.
DataType	getDatatype() Returns the data type of the Parameter.
Object	getEndValue() Returns the last value of a range of parameter values or null if no range was specified.
String	getErrorMessage() If a value could not be set successfully this method returns the corresponding error message.
String	getList() Returns a list of all parameter values as a String or null if no parameter values have been set.
String	getName() Returns the name of the Parameter.
ParameterSet	getNeededReference() Returns a reference to a ParameterSet whose ParameterSet.hasDefaultOrIsSet()-method depends on the value of this Parameter.
int	getNumberOfNexts(int afterIndex) Returns the number of calls of next() that can be done before obtaining false.
int	getNumberOfValues() Returns the number of values in a list or range of parameter values.
String	getScale() Returns a description of the the scale of a range of parameter values.
Object	getStartValue() Returns the start value of a range of parameter values or null if no range was specified.
int	getSteps() Returns the number of steps of a range of parameter values or 0 if no range was specified.
Object	getValue() Returns the current value of this Parameter.
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	isRequired() Returns true if the Parameter is required, false otherwise.
boolean	isSet() Returns true if the parameter was set by the user, false otherwise.
boolean	next() Returns true if the next element still exists and can be fetched using getValue(), false otherwise.
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.
void	setNeededReference(ParameterSet reference) Sets an internal reference to a ParameterSet whose validity depends on the value of this Parameter.
void	setShallBeRanged(RangeParameter.RangeType shallBeRanged) Sets the type of this RangeParameter to one of LIST, RANGE or NO.
void	setValue(Object value) Sets the value of this Parameter to value.
void	setValues(Object startValue, int steps, Object endValue, RangeParameter.Scale scale) Sets the values of this RangeParameter as a range of values, specified by a start value, a last value, a number of steps between these values (without the last value) and a scale in that the values between the first and the last value are chosen.
void	setValues(String values) Sets a list of values from a String containing a space separated list of values.
void	setValuesInLogScale(boolean log, double radix, Object startValue, int steps, Object endValue) This method enables you to set a list of values in an easy manner.
RangeParameter.RangeType	shallBeRanged() Returns one of LIST, RANGE or NO depending on the input used to specify this RangeParameter.
void	simplify() Simplifies the Parameter and its contents to the relevant information.
void	toGalaxy(String namePrefix, String configPrefix, int depth, StringBuffer descBuffer, StringBuffer configBuffer) Creates an Galaxy XML-representation of the parameters and appends it to descBuffer and variable configuration and appends it to configBuffer.
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.Parameter

getId, getNeededReferenceId, getParent, setParent

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RangeParameter

public RangeParameter(SimpleParameter par)
               throws Exception

Constructs a RangeParameter from a SimpleParameter that is rangeable.

Parameters:

par - the rangeable SimpleParameter

Throws:

Exception - if the SimpleParameter is not rangeable, i.e. its method SimpleParameter.isRangeable() returns false

RangeParameter

public RangeParameter(StringBuffer representation)
               throws NonParsableException

The standard constructor for the interface Storable. Restores a RangeParameter from its XML representation.

Parameters:

representation - the XML representation as StringBuffer

Throws:

NonParsableException - if the StringBuffer representation could not be parsed

Method Detail

clone

public RangeParameter clone()
                     throws CloneNotSupportedException

Overrides:

clone in class Parameter

Throws:

CloneNotSupportedException

getCollectionOfScales

public static CollectionParameter getCollectionOfScales()
                                                 throws ParameterException

Returns a CollectionParameter that allows the user to choose between different scales.

Returns:

the CollectionParameter

Throws:

ParameterException - if the CollectionParameter could, or if one of the possible values of the CollectionParameter was not legal

getName

public String getName()

Description copied from class: Parameter

Returns the name of the Parameter.

Specified by:

getName in class Parameter

Returns:

the name of the Parameter

getList

public String getList()

Returns a list of all parameter values as a String or null if no parameter values have been set.

Returns:

the list of all parameter values or null

getStartValue

public Object getStartValue()

Returns the start value of a range of parameter values or null if no range was specified.

Returns:

the start value of a range of parameter values or null

getEndValue

public Object getEndValue()

Returns the last value of a range of parameter values or null if no range was specified.

Returns:

the last value of a range of parameter values or null

getSteps

public int getSteps()

Returns the number of steps of a range of parameter values or 0 if no range was specified.

Returns:

the number of steps of a range of parameter values or 0

getScale

public String getScale()

Returns a description of the the scale of a range of parameter values.

Returns:

the description of the the scale of a range of parameter values

See Also:

RangeParameter.Scale

getDatatype

public DataType getDatatype()

Description copied from class: Parameter

Returns the data type of the Parameter.

Specified by:

getDatatype in class Parameter

Returns:

the data type of the Parameter

getComment

public String getComment()

Description copied from class: Parameter

Returns a comment on this Parameter that tells something about useful values, domains, usage of this parameter, etc.

Specified by:

getComment in class Parameter

Returns:

the comment

isRequired

public boolean isRequired()

Description copied from class: Parameter

Returns true if the Parameter is required, false otherwise.

Specified by:

isRequired in class Parameter

Returns:

true if the Parameter is required, false otherwise

checkValue

public boolean checkValue(Object value)

Description copied from class: Parameter

Checks the value for correctness, e.g. for numerical parameters this might be checking if the value is within specified bounds.

Specified by:

checkValue in class Parameter

Parameters:

value - the value to be checked

Returns:

true if the value is valid, false otherwise

setValue

public void setValue(Object value)
              throws SimpleParameter.IllegalValueException

Description copied from class: Parameter

Sets the value of this Parameter to value.

Specified by:

setValue in class Parameter

Parameters:

value - the new value of the Parameter

Throws:

SimpleParameter.IllegalValueException - if the specified value is not valid for this Parameter

setValues

public void setValues(String values)
               throws SimpleParameter.IllegalValueException

Sets a list of values from a String containing a space separated list of values. After this method has been called, shallBeRanged() returns RangeParameter.RangeType.LIST.

Parameters:

values - the space separated list of values

Throws:

SimpleParameter.IllegalValueException - if at least one of the values in the list is not suitable for this RangeParameter

setValues

public void setValues(Object startValue,
                      int steps,
                      Object endValue,
                      RangeParameter.Scale scale)
               throws SimpleParameter.IllegalValueException

Sets the values of this RangeParameter as a range of values, specified by a start value, a last value, a number of steps between these values (without the last value) and a scale in that the values between the first and the last value are chosen. This range must be one of LOGSCALE, INVERSELOGSCALE, LINSCALE, EXPSCALE, LOGSCALE2, INVERSELOGSCALE2, LOGSCALE10 or INVERSELOGSCALE10.

Parameters:

startValue - the first value of the range

steps - the number of steps between startValue and endValue (exclusive)

endValue - the last value of the range

scale - the RangeParameter.Scale

Throws:

SimpleParameter.IllegalValueException - if one of the values is not suitable for this RangeParameter, e.g. is out of a specified range of allowed values

See Also:

RangeParameter.Scale

setValuesInLogScale

public void setValuesInLogScale(boolean log,
                                double radix,
                                Object startValue,
                                int steps,
                                Object endValue)
                         throws SimpleParameter.IllegalValueException

This method enables you to set a list of values in an easy manner. The values of the list are from the interval [startValue,endValue] in (inverse) logarithmic scale.

Parameters:

log - if true a logarithmic scale is used, otherwise the inverse logarithmic scale

radix - the radix for the scale

startValue - the first value of the range

steps - the number of steps between startValue and endValue (exclusive)

endValue - the last value of the range

Throws:

SimpleParameter.IllegalValueException - if some constraints are not fulfilled

getValue

public Object getValue()

Description copied from class: Parameter

Returns the current value of this Parameter.

Specified by:

getValue in class Parameter

Returns:

the current value of the Parameter

next

public boolean next()
             throws SimpleParameter.IllegalValueException

Returns true if the next element still exists and can be fetched using getValue(), false otherwise.

Specified by:

next in interface RangeIterator

Returns:

true if the next element exists and can be fetched, false otherwise

Throws:

SimpleParameter.IllegalValueException - if the next value to be fetched is not valid

See Also:

setValue(Object)

getNumberOfValues

public int getNumberOfValues()

Returns the number of values in a list or range of parameter values.

Specified by:

getNumberOfValues in interface RangeIterator

Returns:

the number of values

getNumberOfNexts

public int getNumberOfNexts(int afterIndex)

Returns the number of calls of next() that can be done before obtaining false.

Parameters:

afterIndex - the index after which next() shall be called

Returns:

the number of possible calls of next() after afterIndex

shallBeRanged

public RangeParameter.RangeType shallBeRanged()

Returns one of LIST, RANGE or NO depending on the input used to specify this RangeParameter.

Returns:

the type of range specification

See Also:

RangeParameter.RangeType

setShallBeRanged

public void setShallBeRanged(RangeParameter.RangeType shallBeRanged)
                      throws Exception

Sets the type of this RangeParameter to one of LIST, RANGE or NO.

Parameters:

shallBeRanged - the RangeParameter.RangeType of this parameter

Throws:

Exception - if shallBeRanged is none of the allowed values

See Also:

RangeParameter.RangeType

hasDefaultOrIsSet

public boolean hasDefaultOrIsSet()

Description copied from class: Parameter

Returns true if the parameter either has a default value or the value was set by the user, false otherwise.

Specified by:

hasDefaultOrIsSet in class Parameter

Returns:

true if value has a default value or was set, false otherwise

isSet

public boolean isSet()

Description copied from class: Parameter

Returns true if the parameter was set by the user, false otherwise.

Specified by:

isSet in class Parameter

Returns:

true if the parameter was set, false otherwise

isAtomic

public boolean isAtomic()

Description copied from class: Parameter

Returns true if the parameter is of an atomic data type, false otherwise.

Specified by:

isAtomic in class Parameter

Returns:

true if the parameter is atomic, false otherwise

getErrorMessage

public String getErrorMessage()

Description copied from class: Parameter

If a value could not be set successfully this method returns the corresponding error message.

Specified by:

getErrorMessage in class Parameter

Returns:

an error message if a value could not be set successfully

toXML

public StringBuffer toXML()

Description copied from interface: Storable

This method returns an XML representation as StringBuffer of an instance of the implementing class.

Specified by:

toXML in interface Storable

Overrides:

toXML in class Parameter

Returns:

the XML representation

fromXML

protected void fromXML(StringBuffer representation)
                throws NonParsableException

Description copied from class: Parameter

Parses a Parameter from a XML representation as returned by Parameter.toXML().

Overrides:

fromXML in class Parameter

Parameters:

representation - the XML representation as StringBuffer

Throws:

NonParsableException - if the XML code could not be parsed

See Also:

Parameter.toXML()

simplify

public void simplify()

Description copied from class: Parameter

Simplifies the 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.

Specified by:

simplify in class Parameter

reset

public void reset()

Description copied from class: Parameter

Resets the parameter and its contents to the default values or null if no defaults are given.

Specified by:

reset in class Parameter

resetToFirst

public void resetToFirst()

Description copied from interface: RangeIterator

Resets the current value in the collection to the first value.

Specified by:

resetToFirst in interface RangeIterator

setDefault

public void setDefault(Object defaultValue)
                throws Exception

Description copied from class: Parameter

Sets the default value of the Parameter to defaultValue.

Specified by:

setDefault in class Parameter

Parameters:

defaultValue - the default value

Throws:

Exception - if the default value is not an appropriate value for this Parameter

valuesToString

public String valuesToString()

Description copied from interface: RangeIterator

Returns a String representation of the set of values.

Specified by:

valuesToString in interface RangeIterator

Returns:

the String representation

isRanged

public boolean isRanged()

Description copied from interface: RangeIterator

Returns true if this RangeIterator is ranging over a set of values.

Specified by:

isRanged in interface RangeIterator

Returns:

true if this RangeIterator is ranging over a set of values, false otherwise

getNeededReference

public ParameterSet getNeededReference()

Description copied from class: Parameter

Returns a reference to a ParameterSet whose ParameterSet.hasDefaultOrIsSet()-method depends on the value of this Parameter. If no such ParameterSet exists, null is returned.

Overrides:

getNeededReference in class Parameter

Returns:

the reference to the ParameterSet

See Also:

ParameterSet.hasDefaultOrIsSet()

setNeededReference

public void setNeededReference(ParameterSet reference)

Description copied from class: Parameter

Sets an internal reference to a ParameterSet whose validity depends on the value of this Parameter.

Overrides:

setNeededReference in class Parameter

Parameters:

reference - to the ParameterSet depending on the value of this Parameter

toGalaxy

public void toGalaxy(String namePrefix,
                     String configPrefix,
                     int depth,
                     StringBuffer descBuffer,
                     StringBuffer configBuffer)
              throws Exception

Description copied from interface: GalaxyConvertible

Creates an Galaxy XML-representation of the parameters and appends it to descBuffer and variable configuration and appends it to configBuffer. The variable configuation is also used to parse user-supplied values returned by Galaxy.

Specified by:

toGalaxy in interface GalaxyConvertible

Parameters:

namePrefix - the prefix of the variable name used in Galaxy

configPrefix - the prefix for conditionals

depth - the depth in the parameter hierarchy, used for graphical representation of nesting

descBuffer - the buffer for the parameter description

configBuffer - the buffer for the configuration line

Throws:

Exception - if the conversion fails

fromGalaxy

public void fromGalaxy(String namePrefix,
                       StringBuffer command)
                throws Exception

Description copied from interface: GalaxyConvertible

Parses the contents of command in the format defined by configBuffer of GalaxyConvertible.toGalaxy(String, String, int, StringBuffer, StringBuffer) and sets the values of the Parameter or ParameterSet accordingly.

Specified by:

fromGalaxy in interface GalaxyConvertible

Parameters:

namePrefix - the prefix of the variable name

command - the command string

Throws:

Exception - if the command string could not be parsed