Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<List<T>,List<T>>
          extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.ListParameter<List<Double>>
              extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.VectorListParameter

public class VectorListParameter
extends ListParameter<List<Double>>

Parameter class for a parameter specifying a list of vectors.

Author:
Steffi Wanka

Field Summary
 
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
VectorListParameter(OptionID optionID)
          Constructs a vector list parameter with the given name and description.
VectorListParameter(OptionID optionID, ParameterConstraint<List<List<Double>>> constraint)
          Constructs a vector list parameter with the given name and description.
VectorListParameter(OptionID optionID, ParameterConstraint<List<List<Double>>> constraint, boolean optional, List<List<Double>> defaultValue)
          Constructs a vector list parameter with the given name and description.
 
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.
 int[] vectorSizes()
          Returns an array containing the individual vector sizes of this vector list parameter.
 
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
 

Constructor Detail

VectorListParameter

public VectorListParameter(OptionID optionID)
Constructs a vector list parameter with the given name and description.

Parameters:
optionID -

VectorListParameter

public VectorListParameter(OptionID optionID,
                           ParameterConstraint<List<List<Double>>> constraint)
Constructs a vector list parameter with the given name and description.

Parameters:
optionID -
constraint -

VectorListParameter

public VectorListParameter(OptionID optionID,
                           ParameterConstraint<List<List<Double>>> constraint,
                           boolean optional,
                           List<List<Double>> defaultValue)
Constructs a vector list parameter with the given name and description.

Parameters:
optionID -
constraint -
optional -
defaultValue -
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<List<Double>>>
Parameters:
value - the option's value to be set
Throws:
ParameterException - if the given value is not a valid value for this option.

vectorSizes

public int[] vectorSizes()
Returns an array containing the individual vector sizes of this vector list parameter.

Returns:
the individual vector sizes

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<List<Double>>>
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<List<Double>>>
Returns:
"<double_11,...,double_1n:...:double_m1,...,double_mn>" ;

Release 0.2 (2009-07-06_1820)