Package | Description |
---|---|
de.lmu.ifi.dbs.elki.utilities.optionhandling |
Parameter handling and option descriptions.
|
de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints |
Constraints allow to restrict possible values for parameters.
|
de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization |
Configuration managers
See the
de.lmu.ifi.dbs.elki.utilities.optionhandling package for documentation! |
de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters |
Classes for various typed parameters.
|
Modifier and Type | Class and Description |
---|---|
class |
InternalParameterizationErrors
Pseudo error class that wraps multiple error reports into one.
|
class |
NoParameterValueException
Thrown by OptionHandler in case of incorrect parameter-array.
|
class |
UnspecifiedParameterException
Exception when a required parameter was not given.
|
class |
UnusedParameterException
Thrown by OptionHandler in case of request of an unused parameter.
|
class |
WrongParameterValueException
Thrown by a Parameterizable object in case of wrong parameter format.
|
Modifier and Type | Method and Description |
---|---|
void |
LessGlobalConstraint.test()
Checks if the value of the first number parameter is less than the value of
the second number parameter.
|
void |
NoDuplicateValueGlobalConstraint.test()
Checks if the elements of the list of number parameters do have different
values.
|
void |
AllOrNoneMustBeSetGlobalConstraint.test()
Checks if either all elements of a list of parameters are set, or none of
them.
|
void |
ParameterFlagGlobalConstraint.test()
Checks the parameter for its parameter constraints dependent on the status
of the given flag.
|
void |
GlobalVectorListElementSizeConstraint.test()
Checks if the dimensions of each vector of the vector list parameter have
the appropriate size provided by the integer parameter.
|
void |
GlobalParameterConstraint.test()
Checks if the respective parameters satisfy the parameter constraint.
|
void |
LessEqualGlobalConstraint.test()
Checks if the value of the first number parameter is less equal than the
value of the second number parameter.
|
void |
OnlyOneIsAllowedToBeSetGlobalConstraint.test()
Checks if only one parameter of a list of parameters is set.
|
void |
EqualSizeGlobalConstraint.test()
Checks if the list parameters have equal list sizes.
|
void |
OneMustBeSetGlobalConstraint.test()
Checks if at least one parameter value of the list of parameters specified
is set.
|
void |
GlobalListSizeConstraint.test()
Checks is the size of the list parameter is equal to the constraint list
size specified.
|
void |
ListEachConstraint.test(int[] t) |
void |
ListParameterNoDuplicateValueConstraint.test(List<T> list)
Checks if the elements of the list of parameter values do have different
values.
|
void |
LessEqualConstraint.test(Number t)
Checks if the number value given by the number parameter is less equal than
the constraint value.
|
void |
GreaterEqualConstraint.test(Number t)
Checks if the number value given by the number parameter is greater equal
than the constraint value.
|
void |
GreaterConstraint.test(Number t)
Checks if the number value given by the number parameter is greater than
the constraint value.
|
void |
LessConstraint.test(Number t)
Checks if the number value given by the number parameter is less than the
constraint value.
|
void |
ListSizeConstraint.test(Object t)
Checks if the list parameter fulfills the size constraint.
|
void |
EqualStringConstraint.test(String t)
Checks if the given string value of the string parameter is equal to one of
the constraint strings.
|
void |
StringLengthConstraint.test(String t)
Checks if the given string value of the string parameter is within the
length restrictions.
|
void |
ParameterConstraint.test(T t)
Checks if the value
t of the parameter to be tested fulfills the parameter constraint. |
Modifier and Type | Field and Description |
---|---|
(package private) List<ParameterException> |
UnParameterization.errors
Errors
|
(package private) List<ParameterException> |
AbstractParameterization.errors
Errors
|
Modifier and Type | Method and Description |
---|---|
Collection<ParameterException> |
UnParameterization.getErrors() |
Collection<ParameterException> |
Parameterization.getErrors()
Get the configuration errors thrown in
Parameterization.grab(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter<?>) |
Collection<ParameterException> |
MergedParameterization.getErrors() |
Collection<ParameterException> |
TrackParameters.getErrors() |
Collection<ParameterException> |
AbstractParameterization.getErrors() |
Modifier and Type | Method and Description |
---|---|
void |
UnParameterization.reportError(ParameterException e) |
void |
Parameterization.reportError(ParameterException e)
Report a configuration error.
|
void |
ChainedParameterization.reportError(ParameterException e) |
void |
MergedParameterization.reportError(ParameterException e) |
void |
TrackParameters.reportError(ParameterException e) |
void |
AbstractParameterization.reportError(ParameterException e) |
Modifier and Type | Method and Description |
---|---|
boolean |
Parameterization.setValueForOption(Parameter<?> opt)
Assign a value for an option, but not using default values and throwing
exceptions on error.
|
boolean |
ListParameterization.setValueForOption(Parameter<?> opt) |
boolean |
ChainedParameterization.setValueForOption(Parameter<?> opt) |
boolean |
MergedParameterization.setValueForOption(Parameter<?> opt) |
boolean |
TrackParameters.setValueForOption(Parameter<?> opt) |
boolean |
SerializedParameterization.setValueForOption(Parameter<?> opt) |
abstract boolean |
AbstractParameterization.setValueForOption(Parameter<?> opt)
Perform the actual parameter assignment.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractParameter.isValid(Object obj) |
boolean |
Parameter.isValid(Object obj)
Checks if the given argument is valid for this option.
|
protected Long |
LongParameter.parseValue(Object obj) |
protected List<File> |
FileListParameter.parseValue(Object obj) |
protected E |
EnumParameter.parseValue(Object obj) |
protected String |
StringParameter.parseValue(Object obj) |
protected List<Class<? extends C>> |
ObjectListParameter.parseValue(Object obj) |
protected List<Class<? extends C>> |
ClassListParameter.parseValue(Object obj) |
protected Boolean |
Flag.parseValue(Object obj) |
protected abstract T |
AbstractParameter.parseValue(Object obj)
Parse a given value into the destination type.
|
protected Pattern |
PatternParameter.parseValue(Object obj) |
protected List<Vector> |
VectorListParameter.parseValue(Object obj) |
protected Class<? extends C> |
ClassParameter.parseValue(Object obj) |
protected Integer |
IntParameter.parseValue(Object obj) |
protected RandomFactory |
RandomParameter.parseValue(Object obj) |
protected double[] |
DoubleListParameter.parseValue(Object obj) |
protected Class<? extends C> |
ObjectParameter.parseValue(Object obj) |
protected File |
FileParameter.parseValue(Object obj) |
protected int[] |
IntListParameter.parseValue(Object obj) |
void |
AbstractParameter.setValue(Object obj) |
void |
RandomParameter.setValue(Object obj) |
void |
Parameter.setValue(Object obj)
Sets the value of the option.
|
void |
ObjectParameter.setValue(Object obj) |
protected boolean |
Flag.validate(Boolean obj) |
boolean |
ClassParameter.validate(Class<? extends C> obj)
Checks if the given parameter value is valid for this ClassParameter.
|
protected boolean |
FileParameter.validate(File obj) |
protected boolean |
ClassListParameter.validate(List<Class<? extends C>> obj) |
protected boolean |
FileListParameter.validate(List<File> obj) |
protected boolean |
AbstractParameter.validate(T obj)
Validate a value after parsing (e.g. do constrain checks!)
|
Copyright © 2015 ELKI Development Team, Lehr- und Forschungseinheit für Datenbanksysteme, Ludwig-Maximilians-Universität München. License information.