Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.utilities.optionhandling
Class FileParameter

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<File,Object>
          extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.FileParameter

public class FileParameter
extends Parameter<File,Object>

Parameter class for a parameter specifying a file.

Author:
Steffi Wanka

Nested Class Summary
static class FileParameter.FileType
          Available file types: FileParameter.FileType.INPUT_FILE denotes an input file, FileParameter.FileType.OUTPUT_FILE denotes an output file.
 
Field Summary
private  FileParameter.FileType fileType
          The file type of this file parameter.
 
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter
constraints, defaultValue, optionalParameter
 
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.Option
optionid, shortDescription, value
 
Constructor Summary
FileParameter(OptionID optionID, FileParameter.FileType fileType)
          Constructs a file parameter with the given optionID, and file type.
FileParameter(OptionID optionID, FileParameter.FileType fileType, boolean optional)
          Constructs a file parameter with the given optionID, file type, and optional flag.
 
Method Summary
 String getSyntax()
          Returns a string representation of the parameter's type.
 boolean isValid(String value)
          Checks if the given argument is valid for this option.
 void setValue(String value)
          Sets the value of the option.
 
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter
addConstraint, addConstraintList, getDefaultValue, getFullDescription, getValue, getValuesDescription, hasDefaultValue, hasValuesDescription, isOptional, isSet, reset, setDefaultValue, setDefaultValueToValue, setOptional, tookDefaultValue
 
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.Option
getName, getOptionID, getShortDescription, setShortDescription
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fileType

private FileParameter.FileType fileType
The file type of this file parameter. Specifies if the file is an input of output file.

Constructor Detail

FileParameter

public FileParameter(OptionID optionID,
                     FileParameter.FileType fileType)
Constructs a file parameter with the given optionID, and file type.

Parameters:
optionID - optionID the unique id of the option
fileType - the file type of this file parameter

FileParameter

public FileParameter(OptionID optionID,
                     FileParameter.FileType fileType,
                     boolean optional)
Constructs a file parameter with the given optionID, file type, and optional flag.

Parameters:
optionID - optionID the unique id of the option
fileType - the file type of this file parameter
optional - specifies if this parameter is an optional parameter
Method Detail

setValue

public void setValue(String value)
              throws ParameterException
Description copied from class: Option
Sets the value of the option.

Specified by:
setValue in class Option<File>
Parameters:
value - the option's value to be set
Throws:
ParameterException - if the given value is not a valid value for this option.

isValid

public boolean isValid(String value)
                throws ParameterException
Description copied from class: Option
Checks if the given argument is valid for this option.

Specified by:
isValid in class Option<File>
Parameters:
value - option value to be checked
Returns:
true, if the given value is valid for this option
Throws:
ParameterException - if the given value is not a valid value for this option.

getSyntax

public String getSyntax()
Returns a string representation of the parameter's type.

Specified by:
getSyntax in class Option<File>
Returns:
"<file_>"

Release 0.2 (2009-07-06_1820)