E
- the subclass of Number
to be validatedpublic class NumberValidator<E extends Comparable<? extends Number>> extends Object implements ParameterValidator, GalaxyConvertible
Number
that implement
Comparable
(e.g. Double, Long, Float
) for compliance
with a specified lower and upper bound.Constructor and Description |
---|
NumberValidator(E lowerBound,
E upperBound)
Constructs a
NumberValidator for a given upper and lower bound. |
NumberValidator(StringBuffer representation)
The standard constructor for the interface
Storable . |
Modifier and Type | Method and Description |
---|---|
boolean |
checkValue(Object value)
Returns
true if the value is valid and false
otherwise. |
NumberValidator |
clone()
This method returns a deep copy of the current instance.
|
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, boolean)
and sets the values of the Parameter or ParameterSet accordingly. |
void |
fromXML(StringBuffer representation)
Parses a
NumberValidator from the XML representation as returned
by toXML() . |
String |
getErrorMessage()
Returns the error message if
ParameterValidator.checkValue(Object) returned false. |
E |
getLowerBound()
Returns the lower bound of the
NumberValidator . |
void |
toGalaxy(String namePrefix,
String configPrefix,
int depth,
StringBuffer descBuffer,
StringBuffer configBuffer,
boolean addLine)
Creates an Galaxy XML-representation of the parameters and appends it to
descBuffer
and variable configuration and appends it to configBuffer . |
String |
toString() |
StringBuffer |
toXML()
This method returns an XML representation as
StringBuffer of an
instance of the implementing class. |
public NumberValidator(E lowerBound, E upperBound)
NumberValidator
for a given upper and lower bound.lowerBound
- the lower boundupperBound
- the upper boundpublic NumberValidator(StringBuffer representation) throws NonParsableException
Storable
.
Constructs a NumberValidator
out of a XML representation.representation
- the XML representation as StringBuffer
NonParsableException
- if the representation could not be parsedpublic NumberValidator clone()
ParameterValidator
clone
in interface ParameterValidator
clone
in class Object
Cloneable
public E getLowerBound()
NumberValidator
.NumberValidator
public String getErrorMessage()
ParameterValidator
ParameterValidator.checkValue(Object)
returned false.getErrorMessage
in interface ParameterValidator
public boolean checkValue(Object value)
ParameterValidator
true
if the value is valid and false
otherwise.checkValue
in interface ParameterValidator
value
- the Object
to be checkedvalue
is validpublic void fromXML(StringBuffer representation) throws NonParsableException
NumberValidator
from the XML representation as returned
by toXML()
.representation
- the XML representationNonParsableException
- if the XML code could not be parsedpublic StringBuffer toXML()
Storable
StringBuffer
of an
instance of the implementing class.public void toGalaxy(String namePrefix, String configPrefix, int depth, StringBuffer descBuffer, StringBuffer configBuffer, boolean addLine) throws Exception
GalaxyConvertible
descBuffer
and variable configuration and appends it to configBuffer
. The variable configuration
is also used to parse user-supplied values returned by Galaxy.toGalaxy
in interface GalaxyConvertible
namePrefix
- the prefix of the variable name used in GalaxyconfigPrefix
- the prefix for conditionalsdepth
- the depth in the parameter hierarchy, used for graphical representation of nestingdescBuffer
- the buffer for the parameter descriptionconfigBuffer
- the buffer for the configuration lineaddLine
- if true, a line is added before the title of a parameterException
- if the conversion failspublic void fromGalaxy(String namePrefix, StringBuffer command) throws Exception
GalaxyConvertible
command
in the format defined by configBuffer
of GalaxyConvertible.toGalaxy(String, String, int, StringBuffer, StringBuffer, boolean)
and sets the values of the Parameter
or ParameterSet
accordingly.fromGalaxy
in interface GalaxyConvertible
namePrefix
- the prefix of the variable namecommand
- the command stringException
- if the command string could not be parsed