Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.utilities.ConstantObject<OptionID>
          extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID
All Implemented Interfaces:
Loggable, Serializable, Comparable<OptionID>

public final class OptionID
extends ConstantObject<OptionID>

An OptionID is used by option handlers as a unique identifier for specific options. There is no option possible without a specific OptionID defined within this class.

Author:
Elke Achtert
See Also:
Serialized Form

Field Summary
static OptionID ALGORITHM
          OptionID for KDDTask.ALGORITHM_PARAM
static OptionID ALGORITHM_TIME
          OptionID for AbstractAlgorithm.TIME_FLAG
static OptionID ALGORITHM_VERBOSE
          OptionID for AbstractAlgorithm.VERBOSE_FLAG
static OptionID CASH_ADJUST
          OptionID for CASH.ADJUST_FLAG
static OptionID CASH_JITTER
          OptionID for CASH.JITTER_PARAM
static OptionID CASH_MAXLEVEL
          OptionID for CASH.MAXLEVEL_PARAM
static OptionID CASH_MINDIM
          OptionID for CASH.MINDIM_PARAM
static OptionID CASH_MINPTS
          OptionID for CASH.MINPTS_PARAM
static OptionID CLIQUE_PRUNE
          OptionID for CLIQUE.PRUNE_FLAG
static OptionID CLIQUE_TAU
          OptionID for CLIQUE.TAU_PARAM
static OptionID CLIQUE_XSI
          OptionID for CLIQUE.XSI_PARAM
static OptionID COPAA_PARTITION_ALGORITHM
          OptionID for COPAA.PARTITION_ALGORITHM_PARAM
static OptionID COPAA_PARTITION_DATABASE
          OptionID for COPAA.PARTITION_DB_PARAM
static OptionID COPAA_PREPROCESSOR
          OptionID for COPAA.PREPROCESSOR_PARAM
static OptionID DATABASE_CONNECTION
          OptionID for KDDTask.DATABASE_CONNECTION_PARAM
static OptionID DEPENDENCY_DERIVATOR_RANDOM_SAMPLE
          OptionID for DependencyDerivator.RANDOM_SAMPLE_FLAG
private  String description
          The description of the OptionID.
static OptionID DESCRIPTION
          OptionID for KDDTask.DESCRIPTION_PARAM
static OptionID DISH_EPSILON
          OptionID for DiSH.EPSILON_PARAM
static OptionID DISH_MU
          OptionID for DiSH.MU_PARAM
static OptionID EM_DELTA
          OptionID for EM.DELTA_PARAM
static OptionID EM_K
          OptionID for EM.K_PARAM
static OptionID HELP
          OptionID for KDDTask.HELP_FLAG
static OptionID HELP_LONG
          OptionID for KDDTask.HELP_LONG_FLAG
static OptionID KMEANS_K
          OptionID for KMeans.K_PARAM
static OptionID KNN_HICO_PREPROCESSOR_K
          OptionID for KnnQueryBasedHiCOPreprocessor.K_PARAM
static OptionID NORMALIZATION
          OptionID for KDDTask.NORMALIZATION_PARAM
static OptionID NORMALIZATION_UNDO
          OptionID for KDDTask.NORMALIZATION_PARAM
static OptionID OPTICS_EPSILON
          OptionID for OPTICS.EPSILON_PARAM
static OptionID OPTICS_MINPTS
          OptionID for OPTICS.MINPTS_PARAM
static OptionID ORCLUS_ALPHA
          OptionID for ORCLUS.ALPHA_PARAM
static OptionID OUTPUT
          OptionID for KDDTask.OUTPUT_PARAM todo richtige beschreibung?
static OptionID PCA_EIGENPAIR_FILTER
          OptionID for AbstractPCA.EIGENPAIR_FILTER_PARAM
static OptionID PROCLUS_M_I
          OptionID for PROCLUS.M_I_PARAM
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug
 
Constructor Summary
private OptionID(String name, String description)
          Provides a new OptionID of the given name and description.
 
Method Summary
 String getDescription()
          Returns the description of this OptionID.
static OptionID getOptionID(String name)
          Returns the OptionID for the given name if it exists, null otherwise.
static OptionID getOrCreateOptionID(String name, String description)
          Gets or creates the OptionID for the given class and given name.
 void setDescription(String description)
          Sets the description of this OptionID.
 
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.ConstantObject
compareTo, equals, getName, hashCode, lookup, readResolve
 
Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HELP

public static final OptionID HELP
OptionID for KDDTask.HELP_FLAG


HELP_LONG

public static final OptionID HELP_LONG
OptionID for KDDTask.HELP_LONG_FLAG


ALGORITHM

public static final OptionID ALGORITHM
OptionID for KDDTask.ALGORITHM_PARAM


DESCRIPTION

public static final OptionID DESCRIPTION
OptionID for KDDTask.DESCRIPTION_PARAM


DATABASE_CONNECTION

public static final OptionID DATABASE_CONNECTION
OptionID for KDDTask.DATABASE_CONNECTION_PARAM


OUTPUT

public static final OptionID OUTPUT
OptionID for KDDTask.OUTPUT_PARAM todo richtige beschreibung? oder sind es directories?


NORMALIZATION

public static final OptionID NORMALIZATION
OptionID for KDDTask.NORMALIZATION_PARAM


NORMALIZATION_UNDO

public static final OptionID NORMALIZATION_UNDO
OptionID for KDDTask.NORMALIZATION_PARAM


ALGORITHM_VERBOSE

public static final OptionID ALGORITHM_VERBOSE
OptionID for AbstractAlgorithm.VERBOSE_FLAG


ALGORITHM_TIME

public static final OptionID ALGORITHM_TIME
OptionID for AbstractAlgorithm.TIME_FLAG


CASH_ADJUST

public static final OptionID CASH_ADJUST
OptionID for CASH.ADJUST_FLAG


CASH_JITTER

public static final OptionID CASH_JITTER
OptionID for CASH.JITTER_PARAM


CASH_MAXLEVEL

public static final OptionID CASH_MAXLEVEL
OptionID for CASH.MAXLEVEL_PARAM


CASH_MINDIM

public static final OptionID CASH_MINDIM
OptionID for CASH.MINDIM_PARAM


CASH_MINPTS

public static final OptionID CASH_MINPTS
OptionID for CASH.MINPTS_PARAM


CLIQUE_PRUNE

public static final OptionID CLIQUE_PRUNE
OptionID for CLIQUE.PRUNE_FLAG


CLIQUE_TAU

public static final OptionID CLIQUE_TAU
OptionID for CLIQUE.TAU_PARAM


CLIQUE_XSI

public static final OptionID CLIQUE_XSI
OptionID for CLIQUE.XSI_PARAM


COPAA_PREPROCESSOR

public static final OptionID COPAA_PREPROCESSOR
OptionID for COPAA.PREPROCESSOR_PARAM


COPAA_PARTITION_ALGORITHM

public static final OptionID COPAA_PARTITION_ALGORITHM
OptionID for COPAA.PARTITION_ALGORITHM_PARAM


COPAA_PARTITION_DATABASE

public static final OptionID COPAA_PARTITION_DATABASE
OptionID for COPAA.PARTITION_DB_PARAM


DEPENDENCY_DERIVATOR_RANDOM_SAMPLE

public static final OptionID DEPENDENCY_DERIVATOR_RANDOM_SAMPLE
OptionID for DependencyDerivator.RANDOM_SAMPLE_FLAG


DISH_EPSILON

public static final OptionID DISH_EPSILON
OptionID for DiSH.EPSILON_PARAM


DISH_MU

public static final OptionID DISH_MU
OptionID for DiSH.MU_PARAM


EM_DELTA

public static final OptionID EM_DELTA
OptionID for EM.DELTA_PARAM


EM_K

public static final OptionID EM_K
OptionID for EM.K_PARAM


KMEANS_K

public static final OptionID KMEANS_K
OptionID for KMeans.K_PARAM


KNN_HICO_PREPROCESSOR_K

public static final OptionID KNN_HICO_PREPROCESSOR_K
OptionID for KnnQueryBasedHiCOPreprocessor.K_PARAM


OPTICS_EPSILON

public static final OptionID OPTICS_EPSILON
OptionID for OPTICS.EPSILON_PARAM


OPTICS_MINPTS

public static final OptionID OPTICS_MINPTS
OptionID for OPTICS.MINPTS_PARAM


ORCLUS_ALPHA

public static final OptionID ORCLUS_ALPHA
OptionID for ORCLUS.ALPHA_PARAM


PCA_EIGENPAIR_FILTER

public static final OptionID PCA_EIGENPAIR_FILTER
OptionID for AbstractPCA.EIGENPAIR_FILTER_PARAM


PROCLUS_M_I

public static final OptionID PROCLUS_M_I
OptionID for PROCLUS.M_I_PARAM


description

private String description
The description of the OptionID.

Constructor Detail

OptionID

private OptionID(String name,
                 String description)
Provides a new OptionID of the given name and description.

All OptionIDs are unique w.r.t. their name. An OptionID provides additionally a description of the option.

Parameters:
name - the name of the option
description - the description of the option
Method Detail

getDescription

public String getDescription()
Returns the description of this OptionID.

Returns:
the description of this OptionID

setDescription

public void setDescription(String description)
Sets the description of this OptionID.

Parameters:
description - the description to be set

getOrCreateOptionID

public static OptionID getOrCreateOptionID(String name,
                                           String description)
Gets or creates the OptionID for the given class and given name. The OptionID usually is named as the classes name (lowercase) as name-prefix and the given name as suffix of the complete name, separated by a dot. For example, the parameter epsilon for the class DBSCAN will be named dbscan.epsilon.

Parameters:
name - the name
description - the description is also set if the named OptionID does exist already
Returns:
the OptionID for the given name

getOptionID

public static OptionID getOptionID(String name)
Returns the OptionID for the given name if it exists, null otherwise.

Parameters:
name - name of the desired OptionID
Returns:
the OptionID for the given name

Release 0.1 (2008-07-10_1838)