de.jstacs.parameters.validation

Class RegExpValidator

java.lang.Object

de.jstacs.parameters.validation.RegExpValidator

All Implemented Interfaces:

GalaxyConvertible, ParameterValidator, Storable, Cloneable

public class RegExpValidator
extends Object
implements ParameterValidator, GalaxyConvertible

ParameterValidator that checks if a given input String matches a regular expression.

Author:

Jan Grau, Jens Keilwagen

Constructor Summary

Constructors

Constructor and Description
RegExpValidator(String regExp) Creates a validator for the given regular expression.
RegExpValidator(StringBuffer xml) Creates a RegExpValidator from its XML representation.

Method Summary

Modifier and Type	Method and Description
boolean	checkValue(Object value) Returns true if the value is valid and false otherwise.
RegExpValidator	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.
String	getErrorMessage() Returns the error message if ParameterValidator.checkValue(Object) returned false.
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.
StringBuffer	toXML() This method returns an XML representation as StringBuffer of an instance of the implementing class.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegExpValidator

public RegExpValidator(String regExp)

Creates a validator for the given regular expression.

Parameters:

regExp - the regular expression

See Also:

Pattern

RegExpValidator

public RegExpValidator(StringBuffer xml)
                throws NonParsableException

Creates a RegExpValidator from its XML representation.

Parameters:

xml - the XML representation

Throws:

NonParsableException - if the XML representation could not be parsed

Method Detail

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

Returns:

the XML representation

checkValue

public boolean checkValue(Object value)

Description copied from interface: ParameterValidator

Returns true if the value is valid and false otherwise.

Specified by:

checkValue in interface ParameterValidator

Parameters:

value - the Object to be checked

Returns:

if value is valid

getErrorMessage

public String getErrorMessage()

Description copied from interface: ParameterValidator

Returns the error message if ParameterValidator.checkValue(Object) returned false.

Specified by:

getErrorMessage in interface ParameterValidator

Returns:

the error message

clone

public RegExpValidator clone()
                      throws CloneNotSupportedException

Description copied from interface: ParameterValidator

This method returns a deep copy of the current instance.

Specified by:

clone in interface ParameterValidator

Overrides:

clone in class Object

Returns:

a deep copy of the current index

Throws:

CloneNotSupportedException - if the ParameterValidator could not be cloned

See Also:

Cloneable

toGalaxy

public void toGalaxy(String namePrefix,
                     String configPrefix,
                     int depth,
                     StringBuffer descBuffer,
                     StringBuffer configBuffer,
                     boolean addLine)
              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 configuration 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

addLine - if true, a line is added before the title of a parameter

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, boolean) 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