Uses of Interface
de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter

Packages that use Parameter

Package	Description
de.lmu.ifi.dbs.elki	ELKI framework "Environment for Developing KDD-Applications Supported by Index-Structures" KDDTask is the main class of the ELKI-Framework for command-line interaction.
de.lmu.ifi.dbs.elki.application	Base classes for stand alone applications.
de.lmu.ifi.dbs.elki.application.internal	Internal utilities for development.
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.result	Result types, representation and handling
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.

Uses of Parameter in de.lmu.ifi.dbs.elki

Fields in de.lmu.ifi.dbs.elki with type parameters of type Parameter

Modifier and Type	Field and Description
private Collection<Pair<Object,Parameter<?>>>	KDDTask.settings The settings used, for settings reporting.
(package private) Collection<Pair<Object,Parameter<?>>>	KDDTask.Parameterizer.settings

Constructor parameters in de.lmu.ifi.dbs.elki with type arguments of type Parameter

Constructor and Description
KDDTask(InputStep inputStep, AlgorithmStep algorithmStep, EvaluationStep evaluationStep, OutputStep outputStep, Collection<Pair<Object,Parameter<?>>> settings) Constructor.

Uses of Parameter in de.lmu.ifi.dbs.elki.application

Method parameters in de.lmu.ifi.dbs.elki.application with type arguments of type Parameter

Modifier and Type	Method and Description
static String	AbstractApplication.usage(Collection<Pair<Object,Parameter<?>>> options) Returns a usage message, explaining all known options

Uses of Parameter in de.lmu.ifi.dbs.elki.application.internal

Methods in de.lmu.ifi.dbs.elki.application.internal with parameters of type Parameter

Modifier and Type	Method and Description
private static void	DocumentParameters.appendDefaultClassLink(Document htmldoc, Parameter<?> opt, Element p)
private static void	DocumentParameters.appendDefaultValueIfSet(Document htmldoc, Parameter<?> par, Element optdd) Append string containing the default value.
private static void	DocumentParameters.appendDefaultValueWiki(DocumentParameters.WikiStream out, Parameter<?> par)

Method parameters in de.lmu.ifi.dbs.elki.application.internal with type arguments of type Parameter

Modifier and Type	Method and Description
private static void	DocumentParameters.buildParameterIndex(Map<Class<?>,List<Parameter<?>>> byclass, Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)
private static void	DocumentParameters.buildParameterIndex(Map<Class<?>,List<Parameter<?>>> byclass, Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)
private static Document	DocumentParameters.makeByClassOverviewHTML(Map<Class<?>,List<Parameter<?>>> byclass)
private static void	DocumentParameters.makeByClassOverviewWiki(Map<Class<?>,List<Parameter<?>>> byclass, DocumentParameters.WikiStream out)
private static Document	DocumentParameters.makeByOptOverviewHTML(Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)
private static void	DocumentParameters.makeByOptOverviewWiki(Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt, DocumentParameters.WikiStream out)

Uses of Parameter in de.lmu.ifi.dbs.elki.gui.configurator

Classes in de.lmu.ifi.dbs.elki.gui.configurator with type parameters of type Parameter

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

Fields in de.lmu.ifi.dbs.elki.gui.configurator declared as Parameter

Modifier and Type	Field and Description
(package private) T	AbstractParameterConfigurator.param The parameter to configure

Methods in de.lmu.ifi.dbs.elki.gui.configurator with parameters of type Parameter

Modifier and Type	Method and Description
void	ParameterConfigurator.addParameter(Object owner, Parameter<?> param, TrackParameters track)
void	ConfiguratorPanel.addParameter(Object owner, Parameter<?> param, TrackParameters track) Add parameter to this panel.
void	ClassParameterConfigurator.addParameter(Object owner, Parameter<?> param, TrackParameters track)
void	ClassListParameterConfigurator.addParameter(Object owner, Parameter<?> param, TrackParameters track)
void	AbstractParameterConfigurator.addParameter(Object owner, Parameter<?> param, TrackParameters track)
private ParameterConfigurator	ConfiguratorPanel.makeConfigurator(Parameter<?> param)

Constructors in de.lmu.ifi.dbs.elki.gui.configurator with parameters of type Parameter

Constructor and Description
TextParameterConfigurator(Parameter<?> param, JComponent parent)

Uses of Parameter in de.lmu.ifi.dbs.elki.gui.util

Classes in de.lmu.ifi.dbs.elki.gui.util that implement Parameter

Modifier and Type	Class and Description
static class	DynamicParameters.RemainingOptions Dummy option class that represents unhandled options

Fields in de.lmu.ifi.dbs.elki.gui.util declared as Parameter

Modifier and Type	Field and Description
protected Parameter<?>	DynamicParameters.Node.param

Methods in de.lmu.ifi.dbs.elki.gui.util with parameters of type Parameter

Modifier and Type	Method and Description
void	DynamicParameters.addParameter(Parameter<?> option, String value, BitSet bits, int depth) Add a single parameter to the list

Constructors in de.lmu.ifi.dbs.elki.gui.util with parameters of type Parameter

Constructor and Description
DynamicParameters.Node(Parameter<?> param, String value, BitSet flags, int depth) Constructor.

Uses of Parameter in de.lmu.ifi.dbs.elki.result

Fields in de.lmu.ifi.dbs.elki.result with type parameters of type Parameter

Modifier and Type	Field and Description
(package private) Collection<Pair<Object,Parameter<?>>>	SettingsResult.settings Settings storage.

Methods in de.lmu.ifi.dbs.elki.result that return types with arguments of type Parameter

Modifier and Type	Method and Description
Collection<Pair<Object,Parameter<?>>>	SettingsResult.getSettings() Get the settings

Constructor parameters in de.lmu.ifi.dbs.elki.result with type arguments of type Parameter

Constructor and Description
SettingsResult(Collection<Pair<Object,Parameter<?>>> settings) Constructor.

Uses of Parameter in de.lmu.ifi.dbs.elki.utilities.optionhandling

Methods in de.lmu.ifi.dbs.elki.utilities.optionhandling with type parameters of type Parameter

Modifier and Type	Method and Description
static <O extends Parameter<?>> String	OptionUtil.optionsNamesToString(List<O> options) Returns a string representation of the specified list of options containing the names of the options.
static <O extends Parameter<?>> String	OptionUtil.optionsNamesToString(O[] options) Returns a string representation of the specified list of options containing the names of the options.
static <N extends Parameter<?>> String	OptionUtil.parameterNamesAndValuesToString(List<N> parameters) Returns a string representation of the list of number parameters containing the names and the values of the parameters.

Methods in de.lmu.ifi.dbs.elki.utilities.optionhandling with parameters of type Parameter

Modifier and Type	Method and Description
static <O extends Parameter<?>> String	OptionUtil.optionsNamesToString(O[] options) Returns a string representation of the specified list of options containing the names of the options.

Method parameters in de.lmu.ifi.dbs.elki.utilities.optionhandling with type arguments of type Parameter

Modifier and Type	Method and Description
static void	OptionUtil.formatForConsole(StringBuilder buf, int width, String indent, Collection<Pair<Object,Parameter<?>>> options) Format a list of options (and associated owning objects) for console help output.

Constructors in de.lmu.ifi.dbs.elki.utilities.optionhandling with parameters of type Parameter

Constructor and Description
UnspecifiedParameterException(Parameter<?> parameter) Constructor with missing Parameter
WrongParameterValueException(Parameter<?> parameter, String read) Thrown by a Parameterizable object in case of wrong parameter format.
WrongParameterValueException(Parameter<?> parameter, String read, String reason) Thrown by a Parameterizable object in case of wrong parameter format.
WrongParameterValueException(Parameter<?> parameter, String read, String reason, Throwable cause) Thrown by a Parameterizable object in case of wrong parameter format.
WrongParameterValueException(Parameter<?> parameter, String read, Throwable cause) Thrown by a Parameterizable object in case of wrong parameter format.

Uses of Parameter in de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints

Fields in de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints declared as Parameter

Modifier and Type	Field and Description
private Parameter<? extends S>	ParameterFlagGlobalConstraint.param Parameter possibly to be checked.
private Parameter<?>[]	AllOrNoneMustBeSetGlobalConstraint.parameterList List of parameters to be checked

Fields in de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints with type parameters of type Parameter

Modifier and Type	Field and Description
private List<Parameter<?>>	OnlyOneIsAllowedToBeSetGlobalConstraint.parameters List of parameters to be checked.
private List<Parameter<?>>	OneMustBeSetGlobalConstraint.parameters List of parameters to be checked.

Constructors in de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints with parameters of type Parameter

Constructor and Description
AllOrNoneMustBeSetGlobalConstraint(Parameter<?>... parameters) Constructs a global parameter constraint for testing if either all elements of a list of parameters are set or none of them.
OneMustBeSetGlobalConstraint(Parameter<?>... params) Creates a One-Must-Be-Set global parameter constraint.
OnlyOneIsAllowedToBeSetGlobalConstraint(Parameter<?>... params) Constructs a global parameter constraint for testing if only one parameter of a list of parameters is set.
ParameterFlagGlobalConstraint(Parameter<? extends S> p, List<? extends ParameterConstraint<? super S>> c, Flag f, boolean flagConstraint) Constructs a global parameter constraint specifying that the testing of the parameter given for keeping the parameter constraints given is dependent on the status of the flag given.

Constructor parameters in de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints with type arguments of type Parameter

Constructor and Description
OneMustBeSetGlobalConstraint(List<Parameter<?>> params) Creates a One-Must-Be-Set global parameter constraint.
OnlyOneIsAllowedToBeSetGlobalConstraint(List<Parameter<?>> params) Constructs a global parameter constraint for testing if only one parameter of a list of parameters is set.

Uses of Parameter in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization

Fields in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization with type parameters of type Parameter

Modifier and Type	Field and Description
(package private) List<Pair<Object,Parameter<?>>>	TrackParameters.options Tracking storage

Methods in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization that return types with arguments of type Parameter

Modifier and Type	Method and Description
Collection<Pair<Object,Parameter<?>>>	TrackParameters.getAllParameters() Get all seen parameters, set or unset, along with their owner objects.

Methods in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization with parameters of type Parameter

Modifier and Type	Method and Description
void	ListParameterization.forwardOption(Parameter<?> param) Convenience - add a Parameter for forwarding
boolean	UnParameterization.grab(Parameter<?> opt)
boolean	Parameterization.grab(Parameter<?> opt) Get the option value from the Parameterization.
boolean	MergedParameterization.grab(Parameter<?> opt)
boolean	TrackParameters.grab(Parameter<?> opt)
boolean	AbstractParameterization.grab(Parameter<?> opt)
boolean	EmptyParameterization.setValueForOption(Parameter<?> opt)
boolean	UnParameterization.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	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.

Constructor parameters in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization with type arguments of type Parameter

Constructor and Description
TrackParameters(Parameterization inner, Object option, List<Pair<Object,Parameter<?>>> options, Map<Object,Object> parents, Map<Object,List<Object>> children) Internal constructor, for nested tracking.

Uses of Parameter in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters

Classes in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters that implement Parameter

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	DistanceParameter<D extends Distance<D>> Parameter class for a parameter specifying a double value.
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 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	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 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.
class	VectorListParameter Parameter class for a parameter specifying a list of vectors.

Methods in de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters that return Parameter

Modifier and Type	Method and Description
Parameter<T>	Parameter.addConstraint(ParameterConstraint<? super T> constraint) Add an additional constraint.
Parameter<T>	Parameter.setOptional(boolean opt) Specifies if this parameter is an optional parameter.