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

java.lang.Object
  de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.UnParameterization

All Implemented Interfaces:

Parameterization

public class UnParameterization
extends Object
implements Parameterization

Parameterization handler that doesn't set any parameters. This is mostly useful for documentation purposes, listing all parameters in a non-recursive way.

Author:

Erich Schubert

Field Summary

(package private) Vector<ParameterException>

errors Errors

Constructor Summary

UnParameterization()

Method Summary

boolean	checkConstraint(GlobalParameterConstraint constraint) Check a parameter constraint.
Parameterization	descend(Parameter<?,?> option) Descend parameterization tree into sub-option.
Collection<ParameterException>	getErrors() Get the configuration errors thrown in Parameterization.grab(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter)
boolean	grab(Parameter<?,?> opt) Get the option value from the Parameterization.
boolean	hasUnusedParameters() Check for unused parameters
void	reportError(ParameterException e) Report a configuration error.
boolean	setValueForOption(Parameter<?,?> opt) Assign a value for an option, but not using default values and throwing exceptions on error.

Methods inherited from class java.lang.Object

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

Field Detail

errors

Vector<ParameterException> errors

Errors

Constructor Detail

UnParameterization

public UnParameterization()

Method Detail

hasUnusedParameters

public boolean hasUnusedParameters()

Description copied from interface: Parameterization

Check for unused parameters

Specified by:

hasUnusedParameters in interface Parameterization

Returns:

true if at least one parameter was not consumed

checkConstraint

public boolean checkConstraint(GlobalParameterConstraint constraint)

Description copied from interface: Parameterization

Check a parameter constraint.

Specified by:

checkConstraint in interface Parameterization

Parameters:

constraint - Parameter constraint

Returns:

test result

getErrors

public Collection<ParameterException> getErrors()

Description copied from interface: Parameterization

Get the configuration errors thrown in Parameterization.grab(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter)

Specified by:

getErrors in interface Parameterization

Returns:

Configuration errors encountered

grab

public boolean grab(Parameter<?,?> opt)

Description copied from interface: Parameterization

Get the option value from the Parameterization. Note: this method returns success; the actual value can be obtained from opt itself! In particular Parameterization.grab(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter) can return true when Flag.getValue() returns false! Instead the semantics of grab are those of Parameter#isDefined(). This method will catch ParameterExceptions and store them to be retrieved by Parameterization.getErrors().

Specified by:

grab in interface Parameterization

Parameters:

opt - Option to add

Returns:

if the value is available (= readable)

reportError

public void reportError(ParameterException e)

Description copied from interface: Parameterization

Report a configuration error.

Specified by:

reportError in interface Parameterization

Parameters:

e - Destination to report errors to

setValueForOption

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

Description copied from interface: Parameterization

Assign a value for an option, but not using default values and throwing exceptions on error.

Specified by:

setValueForOption in interface Parameterization

Parameters:

opt - Parameter to set

Returns:

Success code

Throws:

ParameterException - on assignment errors.

descend

public Parameterization descend(Parameter<?,?> 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.

Specified by:

descend in interface Parameterization

Parameters:

option - Option subtree

Returns:

Parameterization