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

java.lang.Object
  de.lmu.ifi.dbs.elki.utilities.ConstantObject<OptionID>
      de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID

All Implemented Interfaces:

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

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	DATABASE_CONNECTION OptionID for KDDTask.DATABASE_CONNECTION_PARAM
private String	description The description of the OptionID.
static OptionID	DESCRIPTION OptionID for AbstractApplication.DESCRIPTION_PARAM
static OptionID	HELP OptionID for AbstractApplication.HELP_FLAG
static OptionID	HELP_LONG OptionID for AbstractApplication.HELP_LONG_FLAG
static OptionID	NORMALIZATION OptionID for KDDTask.NORMALIZATION_PARAM
static OptionID	NORMALIZATION_UNDO OptionID for KDDTask.NORMALIZATION_PARAM
static OptionID	OUTPUT OptionID for ResultWriter.OUTPUT_PARAM
static OptionID	RESULT_HANDLER OptionID for KDDTask.RESULT_HANDLER_PARAM

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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

HELP

public static final OptionID HELP

OptionID for AbstractApplication.HELP_FLAG

HELP_LONG

public static final OptionID HELP_LONG

OptionID for AbstractApplication.HELP_LONG_FLAG

ALGORITHM

public static final OptionID ALGORITHM

OptionID for KDDTask.ALGORITHM_PARAM

DESCRIPTION

public static final OptionID DESCRIPTION

OptionID for AbstractApplication.DESCRIPTION_PARAM

DATABASE_CONNECTION

public static final OptionID DATABASE_CONNECTION

OptionID for KDDTask.DATABASE_CONNECTION_PARAM

RESULT_HANDLER

public static final OptionID RESULT_HANDLER

OptionID for KDDTask.RESULT_HANDLER_PARAM

OUTPUT

public static final OptionID OUTPUT

OptionID for ResultWriter.OUTPUT_PARAM

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

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