de.jstacs.parameters
Class FileParameter

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

All Implemented Interfaces:

Storable, Cloneable

public class FileParameter
extends Parameter

Class for a parameter that represents a local file.

Author:

Jan Grau

Nested Class Summary

static class

FileParameter.FileRepresentation Class that represents a file

Field Summary

Fields inherited from class de.jstacs.parameters.Parameter

neededReference, neededReferenceId, parent

Constructor Summary

FileParameter(StringBuffer buf)
Restores a file parameter from an XML representation.

FileParameter(String name, String comment, String mime, boolean required)
Creates a file parameter.

FileParameter(String name, String comment, String mime, boolean required, ParameterValidator validator)
Constructs a file parameter.

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
FileParameter	clone()
protected void	fromXML(StringBuffer representation) Parses a Parameter from an XML-representation as returned by Parameter.toXML().
String	getAcceptedMimeType() Returns the mime type of the allowed files
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
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
String	getName() Returns the name of the parameter
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.
boolean	isAtomic() Returns true if the parameter is of an atomic data type
boolean	isRequired() Returns true if the parameter is required, false otherwise
boolean	isSet() Returns true if the parameter was set by the user.
void	reset() Resets the file parameter 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	simplify() Simplifies the Parameter and its contents to the relevant information.
StringBuffer	toXML() This method returns an XML-representation of an instance of the implementing class.

Methods inherited from class de.jstacs.parameters.Parameter

getId, getNeededReference, getNeededReferenceId, getParent, setNeededReference, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

FileParameter

public FileParameter(StringBuffer buf)
              throws NonParsableException

Restores a file parameter from an XML representation.

Parameters:

buf - the XML representation

Throws:

NonParsableException - if the XML code could not be parsed, an Exception is thrown

FileParameter

public FileParameter(String name,
                     String comment,
                     String mime,
                     boolean required)

Creates a file parameter.

Parameters:

name - the name of the parameter

comment - a comment on the parameter

mime - the mime type of allowed files

required - true if the parameter is required to continue

FileParameter

public FileParameter(String name,
                     String comment,
                     String mime,
                     boolean required,
                     ParameterValidator validator)

Constructs a file parameter.

Parameters:

name - the name of the parameter

comment - a comment on the parameter

mime - the mime-type of allowed files

required - true if parameter is required

validator - a validator that validates e.g. the contents of the file

Method Detail

clone

public FileParameter clone()
                    throws CloneNotSupportedException

Overrides:

clone in class Parameter

Throws:

CloneNotSupportedException

getName

public String getName()

Description copied from class: Parameter

Returns the name of the parameter

Specified by:

getName in class Parameter

Returns:

the name

isAtomic

public boolean isAtomic()

Description copied from class: Parameter

Returns true if the parameter is of an atomic data type

Specified by:

isAtomic in class Parameter

Returns:

if the parameter is atomic

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

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:

if the parameter is required

reset

public void reset()

Resets the file parameter to its original state.

Specified by:

reset in class Parameter

getFileContents

public FileParameter.FileRepresentation getFileContents()

Returns the content of the file

Returns:

the content

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:

the error message

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:

if the value is valid

setDefault

public void setDefault(Object defaultValue)
                throws SimpleParameter.IllegalValueException

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:

SimpleParameter.IllegalValueException

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

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

Throws:

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

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

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.

Specified by:

hasDefaultOrIsSet in class Parameter

Returns:

if value has default or is set

isSet

public boolean isSet()

Description copied from class: Parameter

Returns true if the parameter was set by the user.

Specified by:

isSet in class Parameter

Returns:

if the parameter was set

toXML

public StringBuffer toXML()

Description copied from interface: Storable

This method returns an XML-representation 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 an XML-representation as returned by Parameter.toXML().

Overrides:

fromXML in class Parameter

Parameters:

representation - the XML-representation

Throws:

NonParsableException - is thrown if the XML-code could not be parsed

getAcceptedMimeType

public String getAcceptedMimeType()

Returns the mime type of the allowed files

Returns:

the mime type