|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.jstacs.AnnotatedEntity
de.jstacs.parameters.Parameter
de.jstacs.parameters.FileParameter
public class FileParameter
Class for a Parameter
that represents a local file.
Nested Class Summary | |
---|---|
static class |
FileParameter.FileRepresentation
Class that represents a file. |
Field Summary |
---|
Fields inherited from class de.jstacs.parameters.Parameter |
---|
parent |
Fields inherited from class de.jstacs.AnnotatedEntity |
---|
comment, datatype, name |
Constructor Summary | |
---|---|
FileParameter(StringBuffer buf)
The standard constructor for the interface Storable . |
|
FileParameter(String name,
String comment,
String mime,
boolean required)
Creates a FileParameter . |
|
FileParameter(String name,
String comment,
String mime,
boolean required,
ParameterValidator validator)
Constructs a FileParameter . |
Method Summary | |
---|---|
protected void |
appendFurtherInfos(StringBuffer buf)
This method can be used in the method Storable.toXML() to extract
further information (name, comment, datatype). |
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. |
FileParameter |
clone()
|
protected void |
extractFurtherInfos(StringBuffer buf)
This method can be used in the constructor with parameter StringBuffer to
extract the further information. |
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. |
String |
getAcceptedMimeType()
Returns the MIME-type of the allowed files. |
String |
getErrorMessage()
If a value could not be set successfully this method returns the corresponding error message. |
FileParameter.FileRepresentation |
getFileContents()
Returns the content of the file. |
Object |
getValue()
Returns the value of the AnnotatedEntity . |
String |
getXMLTag()
This method returns a tag used as outer tag of the XML description. |
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 |
isRequired()
Returns true if the Parameter is required,
false otherwise. |
boolean |
isSet()
Returns true if the parameter was set by the user,
false otherwise. |
void |
reset()
Resets the FileParameter to its original state. |
void |
setDefault(Object defaultValue)
Sets the default value of the Parameter to
defaultValue . |
void |
setValue(Object value)
Sets the value of this Parameter to value . |
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 . |
Methods inherited from class de.jstacs.parameters.Parameter |
---|
getParent, isComparable, setParent |
Methods inherited from class de.jstacs.AnnotatedEntity |
---|
getComment, getDatatype, getName, toXML |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileParameter(StringBuffer buf) throws NonParsableException
Storable
.
Restores a FileParameter
from an XML representation.
buf
- the XML representation as StringBuffer
NonParsableException
- if the XML code could not be parsedpublic FileParameter(String name, String comment, String mime, boolean required)
FileParameter
.
name
- the name of the parametercomment
- a comment on the parametermime
- the MIME-type of allowed filesrequired
- true
if this FileParameter
is required to
continue, false
otherwisepublic FileParameter(String name, String comment, String mime, boolean required, ParameterValidator validator)
FileParameter
.
name
- the name of the parametercomment
- a comment on the parametermime
- the MIME-type of allowed filesrequired
- true
if this FileParameter
is requiredvalidator
- a validator that validates e.g. the contents of the fileMethod Detail |
---|
public FileParameter clone() throws CloneNotSupportedException
clone
in class Parameter
CloneNotSupportedException
public boolean isAtomic()
Parameter
true
if the parameter is of an atomic data type,
false
otherwise.
isAtomic
in class Parameter
true
if the parameter is atomic, false
otherwisepublic boolean isRequired()
Parameter
true
if the Parameter
is required,
false
otherwise.
isRequired
in class Parameter
true
if the Parameter
is required,
false
otherwisepublic void reset()
FileParameter
to its original state.
reset
in class Parameter
public FileParameter.FileRepresentation getFileContents()
public String getErrorMessage()
Parameter
getErrorMessage
in class Parameter
public boolean checkValue(Object value)
Parameter
checkValue
in class Parameter
value
- the value to be checked
true
if the value is valid, false
otherwisepublic void setDefault(Object defaultValue) throws SimpleParameter.IllegalValueException
Parameter
Parameter
to
defaultValue
. This method also sets the current
value of this Parameter
to the default.
setDefault
in class Parameter
defaultValue
- the default value
SimpleParameter.IllegalValueException
public void setValue(Object value) throws SimpleParameter.IllegalValueException
Parameter
Parameter
to value
.
setValue
in class Parameter
value
- the new value of the Parameter
SimpleParameter.IllegalValueException
- if the specified value is not valid for this
Parameter
public Object getValue()
AnnotatedEntity
AnnotatedEntity
.
getValue
in class AnnotatedEntity
AnnotatedEntity
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 Parameter
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 Parameter
true
if the parameter was set, false
otherwisepublic String getXMLTag()
AnnotatedEntity
getXMLTag
in class AnnotatedEntity
protected void appendFurtherInfos(StringBuffer buf)
AnnotatedEntity
Storable.toXML()
to extract
further information (name, comment, datatype).
appendFurtherInfos
in class Parameter
buf
- a XML representation of the main information as
StringBuffer
Storable.toXML()
protected void extractFurtherInfos(StringBuffer buf) throws NonParsableException
AnnotatedEntity
StringBuffer
to
extract the further information.
extractFurtherInfos
in class Parameter
buf
- a XML represenation of the main information as
StringBuffer
NonParsableException
- if the XML representation is not parsableAnnotatedEntity.AnnotatedEntity(StringBuffer)
public String getAcceptedMimeType()
public void toGalaxy(String namePrefix, String configPrefix, int depth, StringBuffer descBuffer, StringBuffer configBuffer)
GalaxyConvertible
descBuffer
and variable configuration and appends it to configBuffer
. The variable configuation
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 linepublic void fromGalaxy(String namePrefix, StringBuffer command) throws Exception
GalaxyConvertible
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.
fromGalaxy
in interface GalaxyConvertible
namePrefix
- the prefix of the variable namecommand
- the command string
Exception
- if the command string could not be parsed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |