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

java.lang.Object
  de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
      de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<List<T>,List<T>>
          de.lmu.ifi.dbs.elki.utilities.optionhandling.ListParameter<File>
              de.lmu.ifi.dbs.elki.utilities.optionhandling.FileListParameter

public class FileListParameter
extends ListParameter<File>

Parameter class for a parameter specifying a list of files.

Author:

Steffi Wanka

Nested Class Summary

static class

FileListParameter.FilesType Available types of the files: FileListParameter.FilesType.INPUT_FILES denotes input files, FileListParameter.FilesType.OUTPUT_FILES denotes output files.

Field Summary

private FileListParameter.FilesType

filesType Specifies the type of the files, i.e. if the files are input or output files.

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.ListParameter

SPLIT, VECTOR_SPLIT

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

FileListParameter(OptionID optionID, FileListParameter.FilesType filesType)
Constructs a file list parameter with the given optionID, and file type.

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.ListParameter

getListSize, toString

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, wait, wait, wait

Field Detail

filesType

private FileListParameter.FilesType filesType

Specifies the type of the files, i.e. if the files are input or output files.

Constructor Detail

FileListParameter

public FileListParameter(OptionID optionID,
                         FileListParameter.FilesType filesType)

Constructs a file list parameter with the given optionID, and file type.

Parameters:

optionID - the unique id of this file list parameter

filesType - the file type of this file list 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<List<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<List<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<List<File>>

Returns:

"<file_1,...,file_n>"