|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.UnParameterization
public class UnParameterization
Parameterization handler that doesn't set any parameters. This is mostly useful for documentation purposes, listing all parameters in a non-recursive way.
Field Summary | |
---|---|
(package private) Vector<ParameterException> |
errors
Errors |
Constructor Summary | |
---|---|
UnParameterization()
|
Method Summary | ||
---|---|---|
boolean |
checkConstraint(GlobalParameterConstraint constraint)
Check a parameter constraint. |
|
Parameterization |
descend(Object 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 |
hasErrors()
Return true when there have been errors. |
|
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. |
|
|
tryInstantiate(Class<C> c)
Try to instantiate a particular class. |
|
|
tryInstantiate(Class<C> r,
Class<?> c)
Try to instantiate a particular class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
Vector<ParameterException> errors
Constructor Detail |
---|
public UnParameterization()
Method Detail |
---|
public boolean hasUnusedParameters()
Parameterization
hasUnusedParameters
in interface Parameterization
true
if at least one parameter was not consumedpublic boolean checkConstraint(GlobalParameterConstraint constraint)
Parameterization
checkConstraint
in interface Parameterization
constraint
- Parameter constraint
public Collection<ParameterException> getErrors()
Parameterization
Parameterization.grab(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter, ?>)
getErrors
in interface Parameterization
public boolean hasErrors()
Parameterization
hasErrors
in interface Parameterization
public boolean grab(Parameter<?,?> opt)
Parameterization
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 ParameterException
s and store them to be
retrieved by Parameterization.getErrors()
.
grab
in interface Parameterization
opt
- Option to add
public void reportError(ParameterException e)
Parameterization
reportError
in interface Parameterization
e
- Destination to report errors topublic boolean setValueForOption(Parameter<?,?> opt) throws ParameterException
Parameterization
setValueForOption
in interface Parameterization
opt
- Parameter to set
ParameterException
- on assignment errors.public Parameterization descend(Object option)
Parameterization
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.
descend
in interface Parameterization
option
- Option subtree
public <C> C tryInstantiate(Class<C> r, Class<?> c)
Parameterization
tryInstantiate
in interface Parameterization
C
- return typer
- Restriction classc
- Base class
public <C> C tryInstantiate(Class<C> c)
Parameterization
tryInstantiate
in interface Parameterization
C
- return typec
- Base class
|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |