de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters

Class RandomParameter

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter<RandomParameter,RandomFactory>

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.RandomParameter

All Implemented Interfaces:

Parameter<RandomFactory>

public class RandomParameter
extends AbstractParameter<RandomParameter,RandomFactory>

Parameter for random generators and/or random seeds.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Long	seed Seed value, if used

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

constraints, defaultValue, givenValue, optionalParameter, optionid, shortDescription

Constructor Summary

Constructors

Constructor and Description
RandomParameter(OptionID optionID) Constructor without default.
RandomParameter(OptionID optionID, long seed) Constructor with default seed value.
RandomParameter(OptionID optionID, RandomFactory defaultValue) Constructor with default value.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValueAsString() Get the default value as string.
Object	getGivenValue() Get the last given value.
String	getSyntax() Returns a string representation of the parameter's type (e.g. an IntParameter should return <int>).
String	getValueAsString() Get the value as string.
protected RandomFactory	parseValue(Object obj) Parse a given value into the destination type.
void	setValue(Object obj) Sets the value of the option.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter

addConstraint, getDefaultValue, getFullDescription, getName, getOptionID, getShortDescription, getValue, getValuesDescription, hasDefaultValue, hasValuesDescription, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, setValueInternal, tookDefaultValue, tryDefaultValue, useDefaultValue, validate

Methods inherited from class java.lang.Object

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

Field Detail

seed

Long seed

Seed value, if used

Constructor Detail

RandomParameter

public RandomParameter(OptionID optionID)

Constructor without default.

Parameters:

optionID - Option ID

RandomParameter

public RandomParameter(OptionID optionID,
               RandomFactory defaultValue)

Constructor with default value. The default value may be null, which means a new random will be generated.

Parameters:

optionID - Option ID

defaultValue - Default value. If null, a new random object will be created.

RandomParameter

public RandomParameter(OptionID optionID,
               long seed)

Constructor with default seed value.

Parameters:

optionID - Option ID

seed - Default seed.

Method Detail

getSyntax

public String getSyntax()

Description copied from interface: Parameter

Returns a string representation of the parameter's type (e.g. an IntParameter should return <int>).

Specified by:

getSyntax in interface Parameter<RandomFactory>

Specified by:

getSyntax in class AbstractParameter<RandomParameter,RandomFactory>

Returns:

a string representation of the parameter's type

setValue

public void setValue(Object obj)
              throws ParameterException

Description copied from interface: Parameter

Sets the value of the option.

Specified by:

setValue in interface Parameter<RandomFactory>

Overrides:

setValue in class AbstractParameter<RandomParameter,RandomFactory>

Parameters:

obj - the option's value to be set

Throws:

ParameterException - if the given value is not a valid value for this option.

parseValue

protected RandomFactory parseValue(Object obj)
                            throws ParameterException

Description copied from class: AbstractParameter

Parse a given value into the destination type.

Specified by:

parseValue in class AbstractParameter<RandomParameter,RandomFactory>

Parameters:

obj - Object to parse (may be a string representation!)

Returns:

Parsed object

Throws:

ParameterException - when the object cannot be parsed.

getGivenValue

public Object getGivenValue()

Description copied from interface: Parameter

Get the last given value. May return null

Specified by:

getGivenValue in interface Parameter<RandomFactory>

Overrides:

getGivenValue in class AbstractParameter<RandomParameter,RandomFactory>

Returns:

Given value

getValueAsString

public String getValueAsString()

Description copied from interface: Parameter

Get the value as string. May return null

Specified by:

getValueAsString in interface Parameter<RandomFactory>

Specified by:

getValueAsString in class AbstractParameter<RandomParameter,RandomFactory>

Returns:

Value as string

getDefaultValueAsString

public String getDefaultValueAsString()

Description copied from interface: Parameter

Get the default value as string.

Specified by:

getDefaultValueAsString in interface Parameter<RandomFactory>

Overrides:

getDefaultValueAsString in class AbstractParameter<RandomParameter,RandomFactory>

Returns:

default value