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

Class EmptyParameterization

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.AbstractParameterization

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.EmptyParameterization

All Implemented Interfaces:

Parameterization

public class EmptyParameterization
extends AbstractParameterization

Parameterization handler that only allows the use of default values.

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.AbstractParameterization

errors

Constructor Summary

Constructors

Constructor and Description
EmptyParameterization()

Method Summary

Methods

Modifier and Type	Method and Description
Parameterization	descend(Object option) Descend parameterization tree into sub-option.
boolean	hasUnusedParameters() Check for unused parameters
boolean	setValueForOption(Parameter<?,?> opt) Perform the actual parameter assignment.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.AbstractParameterization

checkConstraint, clearErrors, failOnErrors, finalize, getErrors, grab, hasErrors, logAndClearReportedErrors, reportError, reportInternalParameterizationErrors, tryInstantiate, tryInstantiate

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyParameterization

public EmptyParameterization()

Method Detail

hasUnusedParameters

public boolean hasUnusedParameters()

Description copied from interface: Parameterization

Check for unused parameters

Returns:

true if at least one parameter was not consumed

setValueForOption

public boolean setValueForOption(Parameter<?,?> opt)
                          throws ParameterException

Description copied from class: AbstractParameterization

Perform the actual parameter assignment.

Specified by:

setValueForOption in interface Parameterization

Specified by:

setValueForOption in class AbstractParameterization

Parameters:

opt - Option to be set

Returns:

Success code (value available)

Throws:

ParameterException - on assignment errors.

descend

public Parameterization descend(Object option)

Descend parameterization tree into sub-option. Note: this is done automatically by a ClassParameter.instantiateClass(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization). You only need to call this when you want to expose the tree structure without offering a class choice as parameter. Default implementation, for flat parameterizations.

Parameters:

option - Option subtree

Returns:

Parameterization