Package elki.datasource.filter.typeconversions

Class ClassLabelFilter.Par

java.lang.Object

elki.datasource.filter.typeconversions.ClassLabelFilter.Par

All Implemented Interfaces:

Parameterizer

Enclosing class:

ClassLabelFilter

public static class ClassLabelFilter.Par
extends java.lang.Object
implements Parameterizer

Parameterization class.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
static OptionID	CLASS_LABEL_CLASS_ID	Parameter to specify the class of occurring class labels.
static OptionID	CLASS_LABEL_INDEX_ID	Optional parameter that specifies the index of the label to be used as class label, must be an integer equal to or greater than 0.
private ClassLabel.Factory<?>	classLabelFactory	The class label factory to use.
protected int	classLabelIndex	The index of the label to be used as class label, null if no class label is specified.

Constructor Summary

Constructors

Constructor	Description
Par()

Method Summary

Modifier and Type	Method	Description
void	configure(Parameterization config)	Configure the class.
ClassLabelFilter	make()	Make an instance after successful configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_LABEL_INDEX_ID

public static final OptionID CLASS_LABEL_INDEX_ID

Optional parameter that specifies the index of the label to be used as class label, must be an integer equal to or greater than 0.

CLASS_LABEL_CLASS_ID

public static final OptionID CLASS_LABEL_CLASS_ID

Parameter to specify the class of occurring class labels.

classLabelIndex

protected int classLabelIndex

The index of the label to be used as class label, null if no class label is specified.

classLabelFactory

private ClassLabel.Factory<?> classLabelFactory

The class label factory to use.

Constructor Detail

Par

public Par()

Method Detail

configure

public void configure(Parameterization config)

Description copied from interface: Parameterizer

Configure the class.

Note: the status is collected by the parameterization object, so that multiple errors may arise and be reported in one run.

Specified by:

configure in interface Parameterizer

Parameters:

config - Parameterization

make

public ClassLabelFilter make()

Description copied from interface: Parameterizer

Make an instance after successful configuration.

Note: your class should return the exact type, only this very broad interface should use Object as return type.

Specified by:

make in interface Parameterizer

Returns:

a new instance