| Package | Description | 
|---|---|
| de.lmu.ifi.dbs.elki.gui.configurator | 
 Configurator components 
 | 
| de.lmu.ifi.dbs.elki.gui.util | 
 Utility classes for GUIs (e.g. a class to display a logging panel) 
 | 
| de.lmu.ifi.dbs.elki.utilities.optionhandling | 
 Parameter handling and option descriptions. 
 | 
| 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
 
 See the  
de.lmu.ifi.dbs.elki.utilities.optionhandling package for
 documentation! | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractParameterConfigurator<T extends Parameter<?>>
Abstract class to produce a configurator for a particular parameter. 
 | 
class  | 
AbstractSingleParameterConfigurator<T extends Parameter<?>>
Base class for MiniGUI input helpers 
 | 
| Modifier and Type | Field and Description | 
|---|---|
(package private) T | 
AbstractParameterConfigurator.param
The parameter to configure 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ParameterConfigurator.addParameter(java.lang.Object owner,
            Parameter<?> param,
            TrackParameters track)
Add a parameter to the panel. 
 | 
void | 
ClassListParameterConfigurator.addParameter(java.lang.Object owner,
            Parameter<?> param,
            TrackParameters track)  | 
void | 
AbstractParameterConfigurator.addParameter(java.lang.Object owner,
            Parameter<?> param,
            TrackParameters track)  | 
void | 
ConfiguratorPanel.addParameter(java.lang.Object owner,
            Parameter<?> param,
            TrackParameters track)
Add parameter to this panel. 
 | 
void | 
ClassParameterConfigurator.addParameter(java.lang.Object owner,
            Parameter<?> param,
            TrackParameters track)  | 
private ParameterConfigurator | 
ConfiguratorPanel.makeConfigurator(Parameter<?> param)  | 
| Constructor and Description | 
|---|
TextParameterConfigurator(Parameter<?> param,
                         javax.swing.JComponent parent)  | 
| Modifier and Type | Class and Description | 
|---|---|
static class  | 
DynamicParameters.RemainingOptions
Dummy option class that represents unhandled options 
 | 
| Modifier and Type | Field and Description | 
|---|---|
private Parameter<?> | 
ParameterTable.ClassListEditor.option
Parameter we are currently editing. 
 | 
protected Parameter<?> | 
DynamicParameters.Node.param  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
DynamicParameters.addParameter(Parameter<?> option,
            java.lang.String value,
            int bits,
            int depth)
Add a single parameter to the list 
 | 
| Constructor and Description | 
|---|
Node(Parameter<?> param,
    java.lang.String value,
    int flags,
    int depth)
Constructor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static java.lang.String | 
OptionUtil.getFullDescription(Parameter<?> param)
Format a parameter description. 
 | 
static java.lang.String | 
ParameterException.prefixParametersToMessage(Parameter<?> p,
                         java.lang.String mid,
                         Parameter<?> p2,
                         java.lang.String message)
Prefix parameters to error message. 
 | 
static java.lang.String | 
ParameterException.prefixParametersToMessage(Parameter<?> p,
                         java.lang.String mid,
                         Parameter<?> p2,
                         java.lang.String message)
Prefix parameters to error message. 
 | 
static java.lang.String | 
ParameterException.prefixParameterToMessage(Parameter<?> p,
                        java.lang.String message)
Prefix parameter information to error message. 
 | 
| Constructor and Description | 
|---|
ParameterException(Parameter<?> p,
                  java.lang.String message)
Constructor. 
 | 
ParameterException(Parameter<?> p,
                  java.lang.String message,
                  java.lang.Throwable cause)
Constructor. 
 | 
UnspecifiedParameterException(Parameter<?> parameter)
Constructor with missing Parameter 
 | 
WrongParameterValueException(Parameter<?> parameter,
                            java.lang.String mid,
                            Parameter<?> parameter2,
                            java.lang.String reason)
Thrown by a Parameterizable object in case of wrong parameter format. 
 | 
WrongParameterValueException(Parameter<?> parameter,
                            java.lang.String mid,
                            Parameter<?> parameter2,
                            java.lang.String reason)
Thrown by a Parameterizable object in case of wrong parameter format. 
 | 
WrongParameterValueException(Parameter<?> parameter,
                            java.lang.String read,
                            java.lang.String reason)
Thrown by a Parameterizable object in case of wrong parameter format. 
 | 
WrongParameterValueException(Parameter<?> parameter,
                            java.lang.String read,
                            java.lang.String reason,
                            java.lang.Throwable cause)
Thrown by a Parameterizable object in case of wrong parameter format. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
private Parameter<?> | 
TrackedParameter.parameter
Parameter value 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Parameter<?> | 
TrackedParameter.getParameter()
Get the parameter observed. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
UnParameterization.grab(Parameter<?> opt)  | 
default boolean | 
Parameterization.grab(Parameter<?> opt)
Get the option value from the Parameterization. 
 | 
boolean | 
TrackParameters.grab(Parameter<?> opt)  | 
boolean | 
EmptyParameterization.setValueForOption(Parameter<?> opt)  | 
boolean | 
UnParameterization.setValueForOption(Parameter<?> opt)  | 
boolean | 
ListParameterization.setValueForOption(Parameter<?> opt)  | 
boolean | 
Parameterization.setValueForOption(Parameter<?> opt)
Assign a value for an option, but not using default values and throwing
 exceptions on error. 
 | 
boolean | 
TrackParameters.setValueForOption(Parameter<?> opt)  | 
boolean | 
MergedParameterization.setValueForOption(Parameter<?> opt)  | 
boolean | 
SerializedParameterization.setValueForOption(Parameter<?> opt)  | 
boolean | 
ChainedParameterization.setValueForOption(Parameter<?> opt)  | 
| Constructor and Description | 
|---|
TrackedParameter(java.lang.Object owner,
                Parameter<?> parameter)
Constructor. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractParameter<THIS extends AbstractParameter<THIS,T>,T>
Abstract class for specifying a parameter. 
 | 
class  | 
ClassListParameter<C>
Parameter class for a parameter specifying a list of class names. 
 | 
class  | 
ClassParameter<C>
Parameter class for a parameter specifying a class name. 
 | 
class  | 
DoubleArrayListParameter
Parameter class for a parameter specifying a list of vectors. 
 | 
class  | 
DoubleListParameter
Parameter class for a parameter specifying a list of double values. 
 | 
class  | 
DoubleParameter
Parameter class for a parameter specifying a double value. 
 | 
class  | 
EnumParameter<E extends java.lang.Enum<E>>
Parameter class for a parameter specifying an enum type. 
 | 
class  | 
FileListParameter
Parameter class for a parameter specifying a list of files. 
 | 
class  | 
FileParameter
Parameter class for a parameter specifying a file. 
 | 
class  | 
Flag
Option class specifying a flag object. 
 | 
class  | 
IntGeneratorParameter
Parameter class for a parameter specifying ranges of integer values. 
 | 
class  | 
IntListParameter
Parameter class for a parameter specifying a list of integer values. 
 | 
class  | 
IntParameter
Parameter class for a parameter specifying an integer value. 
 | 
class  | 
ListParameter<THIS extends ListParameter<THIS,T>,T>
Abstract parameter class defining a parameter for a list of objects. 
 | 
class  | 
LongParameter
Parameter class for a parameter specifying a long value. 
 | 
class  | 
NumberParameter<THIS extends NumberParameter<THIS,T>,T extends java.lang.Number>
Abstract class for defining a number parameter. 
 | 
class  | 
ObjectListParameter<C>
Parameter that represents a list of objects (in contrast to a class list
 parameter, they will be instanced at most once.) 
 | 
class  | 
ObjectParameter<C>
Parameter class for a parameter representing a single object. 
 | 
class  | 
PatternParameter
Parameter class for a parameter specifying a pattern. 
 | 
class  | 
RandomParameter
Parameter for random generators and/or random seeds. 
 | 
class  | 
StringParameter
Parameter class for a parameter specifying a string. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Parameter<T> | 
Parameter.addConstraint(ParameterConstraint<? super T> constraint)
Add an additional constraint. 
 | 
Parameter<T> | 
Parameter.setDefaultValue(T defaultValue)
Sets the default value of this parameter. 
 | 
Parameter<T> | 
Parameter.setOptional(boolean opt)
Specifies if this parameter is an optional parameter. 
 | 
Copyright © 2019 ELKI Development Team. License information.