Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

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

public class PatternParameter
extends Parameter<String,String>

Parameter class for a parameter specifying a pattern.

Author:
Steffi Wanka

Field Summary
 
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
PatternParameter(OptionID optionID)
          Constructs a pattern parameter with the given optionID.
PatternParameter(OptionID optionID, ParameterConstraint<String> constraint, String defaultValue)
          Constructs a pattern parameter with the given optionID, constraints and default value.
PatternParameter(OptionID optionID, String defaultValue)
          Constructs a pattern parameter with the given optionID, and default value.
 
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
 

Constructor Detail

PatternParameter

public PatternParameter(OptionID optionID)
Constructs a pattern parameter with the given optionID.

Parameters:
optionID - the unique id of the parameter

PatternParameter

public PatternParameter(OptionID optionID,
                        String defaultValue)
Constructs a pattern parameter with the given optionID, and default value.

Parameters:
optionID - the unique id of the parameter
defaultValue - the default value of the parameter

PatternParameter

public PatternParameter(OptionID optionID,
                        ParameterConstraint<String> constraint,
                        String defaultValue)
Constructs a pattern parameter with the given optionID, constraints and default value.

Parameters:
optionID - the unique id of the parameter
constraint - parameter constraint
defaultValue - the default value of the 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<String>
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<String>
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<String>
Returns:
"<pattern>"

Release 0.2.1 (2009-07-13_1605)