ClassListParameter (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter<THIS,T>
- - de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
  - - de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ClassListParameter<C>

Type Parameters:

C - Class type

All Implemented Interfaces:

Parameter<java.util.List<java.lang.Class<? extends C>>>

Direct Known Subclasses:

ObjectListParameter
```
public class ClassListParameter<C>
extends ListParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
```
Parameter class for a parameter specifying a list of class names.

Since:

0.1

Author:

Steffi Wanka, Erich Schubert

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Class<C> restrictionClass
The restriction class for the list of class names.
- Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter
  LIST_SEP, SPLIT, VECTOR_SEP, VECTOR_SPLIT
- Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter
  constraints, defaultValue, givenValue, optionalParameter, optionid, shortDescription

Fields
Modifier and Type	Field and Description
`protected java.lang.Class<C>`	`restrictionClass` The restriction class for the list of class names.

Constructor Summary

Constructors
Constructor and Description
`ClassListParameter(OptionID optionID, java.lang.Class<?> restrictionClass)` Constructs a class list parameter with the given optionID and restriction class.
`ClassListParameter(OptionID optionID, java.lang.Class<?> restrictionClass, boolean optional)` Constructs a class list parameter with the given optionID and restriction class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.StringBuilder`	`describeValues(java.lang.StringBuilder buf)` Describe the valid values.
`protected java.lang.String`	`formatValue(java.util.List<java.lang.Class<? extends C>> val)` Format as string.
`java.lang.String`	`getDefaultValueAsString()` Get the default value as string.
`java.util.List<java.lang.Class<?>>`	`getKnownImplementations()` Get an iterator over all known implementations of the class restriction.
`java.lang.Class<C>`	`getRestrictionClass()` Returns the restriction class of this class parameter.
`java.lang.String`	`getSyntax()` Returns a string representation of the parameter's type.
`java.lang.String`	`getValueAsString()` Get the value as string.
`java.util.List<C>`	`instantiateClasses(Parameterization config)` Returns a list of new instances for the value (i.e., the class name) of this class list parameter.
`protected java.util.List<java.lang.Class<? extends C>>`	`parseValue(java.lang.Object obj)` Parse a given value into the destination type.
`int`	`size()` Size of the list.
`protected boolean`	`validate(java.util.List<java.lang.Class<? extends C>> obj)` Validate a value after parsing (e.g. do constraint checks!)

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter
addConstraint, getConstraints, getDefaultValue, getOptionID, getShortDescription, getValue, hasDefaultValue, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, setValue, setValueInternal, tookDefaultValue, tryDefaultValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - restrictionClass
```
protected java.lang.Class<C> restrictionClass
```
    The restriction class for the list of class names.
- Constructor Detail
  - ClassListParameter
```
public ClassListParameter(OptionID optionID,
                          java.lang.Class<?> restrictionClass,
                          boolean optional)
```
    Constructs a class list parameter with the given optionID and restriction class.
    
    Parameters:
    
    optionID - the unique id of this parameter
    
    restrictionClass - the restriction class of the list of class names
    
    optional - specifies if this parameter is an optional parameter
  - ClassListParameter
```
public ClassListParameter(OptionID optionID,
                          java.lang.Class<?> restrictionClass)
```
    Constructs a class list parameter with the given optionID and restriction class.
    
    Parameters:
    
    optionID - the unique id of this parameter
    
    restrictionClass - the restriction class of the list of class names
- Method Detail
  - getValueAsString
```
public java.lang.String getValueAsString()
```
    Description copied from interface: Parameter
    
    Get the value as string. May return null
    
    Specified by:
    
    getValueAsString in interface Parameter<java.util.List<java.lang.Class<? extends C>>>
    
    Specified by:
    
    getValueAsString in class AbstractParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Returns:
    
    Value as string
  - getDefaultValueAsString
```
public java.lang.String getDefaultValueAsString()
```
    Description copied from interface: Parameter
    
    Get the default value as string.
    
    Specified by:
    
    getDefaultValueAsString in interface Parameter<java.util.List<java.lang.Class<? extends C>>>
    
    Overrides:
    
    getDefaultValueAsString in class AbstractParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Returns:
    
    default value
  - formatValue
```
protected java.lang.String formatValue(java.util.List<java.lang.Class<? extends C>> val)
```
    Format as string.
    
    Parameters:
    
    val - Value to format
    
    Returns:
    
    String
  - parseValue
```
protected java.util.List<java.lang.Class<? extends C>> parseValue(java.lang.Object obj)
                                                           throws ParameterException
```
    Description copied from class: AbstractParameter
    
    Parse a given value into the destination type.
    
    Specified by:
    
    parseValue in class AbstractParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Parameters:
    
    obj - Object to parse (may be a string representation!)
    
    Returns:
    
    Parsed object
    
    Throws:
    
    ParameterException - when the object cannot be parsed.
  - validate
```
protected boolean validate(java.util.List<java.lang.Class<? extends C>> obj)
                    throws ParameterException
```
    Description copied from class: AbstractParameter
    
    Validate a value after parsing (e.g. do constraint checks!)
    
    Overrides:
    
    validate in class AbstractParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Parameters:
    
    obj - Object to validate
    
    Returns:
    
    true iff the object is valid for this parameter.
    
    Throws:
    
    ParameterException - when the object is not valid.
  - getRestrictionClass
```
public java.lang.Class<C> getRestrictionClass()
```
    Returns the restriction class of this class parameter.
    
    Returns:
    
    the restriction class of this class parameter.
  - getKnownImplementations
```
public java.util.List<java.lang.Class<?>> getKnownImplementations()
```
    Get an iterator over all known implementations of the class restriction.
    
    Returns:
    
    List object
  - getSyntax
```
public java.lang.String getSyntax()
```
    Returns a string representation of the parameter's type.
    
    Specified by:
    
    getSyntax in interface Parameter<java.util.List<java.lang.Class<? extends C>>>
    
    Specified by:
    
    getSyntax in class AbstractParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Returns:
    
    "<class_1,...,class_n>"
  - instantiateClasses
```
public java.util.List<C> instantiateClasses(Parameterization config)
```
    Returns a list of new instances for the value (i.e., the class name) of this class list parameter. The instances have the type of the restriction class of this class list parameter.
    If the Class for the class names is not found, the instantiation is tried using the package of the restriction class as package of the class name.
    
    Parameters:
    
    config - Parameterization to use (if Parameterizable))
    
    Returns:
    
    a list of new instances for the value of this class list parameter
  - describeValues
```
public java.lang.StringBuilder describeValues(java.lang.StringBuilder buf)
```
    Description copied from interface: Parameter
    
    Describe the valid values.
    
    Specified by:
    
    describeValues in interface Parameter<java.util.List<java.lang.Class<? extends C>>>
    
    Overrides:
    
    describeValues in class AbstractParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Parameters:
    
    buf - Buffer to append to
    
    Returns:
    
    Buffer
  - size
```
public int size()
```
    Description copied from class: ListParameter
    
    Size of the list.
    
    Specified by:
    
    size in class ListParameter<ClassListParameter<C>,java.util.List<java.lang.Class<? extends C>>>
    
    Returns:
    
    Size

Class ClassListParameter<C>

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter

Constructor Summary

Method Summary

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter

Methods inherited from class java.lang.Object

Field Detail

restrictionClass

Constructor Detail

ClassListParameter

ClassListParameter

Method Detail

getValueAsString

getDefaultValueAsString

formatValue

parseValue

validate

getRestrictionClass

getKnownImplementations

getSyntax

instantiateClasses

describeValues

size