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

Class ClassParameter<C>

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter<ClassParameter<C>,Class<? extends C>>

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ClassParameter<C>

Type Parameters:

C - Class type

All Implemented Interfaces:

Parameter<Class<? extends C>>

Direct Known Subclasses:

ObjectParameter

public class ClassParameter<C>
extends AbstractParameter<ClassParameter<C>,Class<? extends C>>

Parameter class for a parameter specifying a class name.

Author:

Steffi Wanka, Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	LOG The class logger.
protected Class<C>	restrictionClass The restriction class for this class parameter.

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
ClassParameter(OptionID optionID, Class<?> restrictionClass) Constructs a class parameter with the given optionID, and restriction class.
ClassParameter(OptionID optionID, Class<?> restrictionClass, boolean optional) Constructs a class parameter with the given optionID, restriction class, and optional flag.
ClassParameter(OptionID optionID, Class<?> restrictionClass, Class<?> defaultValue) Constructs a class parameter with the given optionID, restriction class, and default value.

Method Summary

Methods

Modifier and Type	Method and Description
static String	canonicalClassName(Class<?> c, Class<?> parent) Get the "simple" form of a class name.
static String	canonicalClassName(Class<?> c, Package pkg, String postfix) Get the "simple" form of a class name.
String	getDefaultValueAsString() Get the default value as string.
List<Class<?>>	getKnownImplementations() Get an iterator over all known implementations of the class restriction.
Class<C>	getRestrictionClass() Returns the restriction class of this class parameter.
String	getSyntax() Returns a string representation of the parameter's type.
String	getValueAsString() Get the value as string.
String	getValuesDescription() Return a description of known valid classes.
boolean	hasValuesDescription() This class sometimes provides a list of value descriptions.
C	instantiateClass(Parameterization config) Returns a new instance for the value (i.e., the class name) of this class parameter.
protected Class<? extends C>	parseValue(Object obj) Parse a given value into the destination type.
boolean	validate(Class<? extends C> obj) Checks if the given parameter value is valid for this ClassParameter.

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

addConstraint, getDefaultValue, getFullDescription, getGivenValue, getName, getOptionID, getShortDescription, getValue, hasDefaultValue, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, useDefaultValue

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

The class logger.

restrictionClass

protected Class<C> restrictionClass

The restriction class for this class parameter.

Constructor Detail

ClassParameter

public ClassParameter(OptionID optionID,
              Class<?> restrictionClass,
              Class<?> defaultValue)

Constructs a class parameter with the given optionID, restriction class, and default value.

Parameters:

optionID - the unique id of the option

restrictionClass - the restriction class of this class parameter

defaultValue - the default value of this class parameter

ClassParameter

public ClassParameter(OptionID optionID,
              Class<?> restrictionClass,
              boolean optional)

Constructs a class parameter with the given optionID, restriction class, and optional flag.

Parameters:

optionID - the unique id of the option

restrictionClass - the restriction class of this class parameter

optional - specifies if this parameter is an optional parameter

ClassParameter

public ClassParameter(OptionID optionID,
              Class<?> restrictionClass)

Constructs a class parameter with the given optionID, and restriction class.

Parameters:

optionID - the unique id of the option

restrictionClass - the restriction class of this class parameter

Method Detail

parseValue

protected Class<? extends C> parseValue(Object obj)
                                 throws ParameterException

Description copied from class: AbstractParameter

Parse a given value into the destination type.

Specified by:

parseValue in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Parameters:

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

Returns:

Parsed object

Throws:

ParameterException - when the object cannot be parsed.

validate

public boolean validate(Class<? extends C> obj)
                 throws ParameterException

Checks if the given parameter value is valid for this ClassParameter. If not a parameter exception is thrown.

Overrides:

validate in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Parameters:

obj - Object to validate

Returns:

true iff the object is valid for this parameter.

Throws:

ParameterException - when the object is not valid.

getSyntax

public String getSyntax()

Returns a string representation of the parameter's type.

Specified by:

getSyntax in interface Parameter<Class<? extends C>>

Specified by:

getSyntax in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Returns:

"<class>"

hasValuesDescription

public boolean hasValuesDescription()

This class sometimes provides a list of value descriptions.

Specified by:

hasValuesDescription in interface Parameter<Class<? extends C>>

Overrides:

hasValuesDescription in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Returns:

whether the class has a description of valid values.

See Also:

AbstractParameter.hasValuesDescription()

getValuesDescription

public String getValuesDescription()

Return a description of known valid classes.

Specified by:

getValuesDescription in interface Parameter<Class<? extends C>>

Overrides:

getValuesDescription in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Returns:

String explaining valid values (e.g. a class list)

See Also:

AbstractParameter.getValuesDescription()

getValueAsString

public String getValueAsString()

Description copied from interface: Parameter

Get the value as string. May return null

Specified by:

getValueAsString in interface Parameter<Class<? extends C>>

Specified by:

getValueAsString in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Returns:

Value as string

instantiateClass

public C instantiateClass(Parameterization config)

Returns a new instance for the value (i.e., the class name) of this class parameter. The instance has the type of the restriction class of this class parameter.

If the Class for the class name is not found, the instantiation is tried using the package of the restriction class as package of the class name.

Parameters:

config - Parameterization to use (if Parameterizable))

Returns:

a new instance for the value of this class parameter

getRestrictionClass

public Class<C> getRestrictionClass()

Returns the restriction class of this class parameter.

Returns:

the restriction class of this class parameter.

getKnownImplementations

public List<Class<?>> getKnownImplementations()

Get an iterator over all known implementations of the class restriction.

Returns:

List object

canonicalClassName

public static String canonicalClassName(Class<?> c,
                        Package pkg,
                        String postfix)

Get the "simple" form of a class name.

Parameters:

c - Class

pkg - Package

postfix - Postfix to strip

Returns:

Simplified class name

canonicalClassName

public static String canonicalClassName(Class<?> c,
                        Class<?> parent)

Get the "simple" form of a class name.

Parameters:

c - Class name

parent - Parent/restriction class (to get package name to strip)

Returns:

Simplified class name.

getDefaultValueAsString

public String getDefaultValueAsString()

Description copied from interface: Parameter

Get the default value as string.

Specified by:

getDefaultValueAsString in interface Parameter<Class<? extends C>>

Overrides:

getDefaultValueAsString in class AbstractParameter<ClassParameter<C>,Class<? extends C>>

Returns:

default value