Package adams.flow.container

Class EvaluationContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.EvaluationContainer

All Implemented Interfaces:

adams.core.CloneHandler<adams.flow.container.Container>, adams.core.GlobalInfoSupporter, adams.data.spreadsheet.SpreadSheetSupporter, adams.flow.container.Container, adams.flow.container.ContainerWithReport, Serializable

public class EvaluationContainer
extends adams.flow.container.AbstractContainer
implements adams.flow.container.ContainerWithReport

Container for evaluations.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_ABSTENTION_CLASSIFICATION	the identifier for the classification of an abstaining classifier.
static String	VALUE_CLASSIFICATION	the identifier for the classification.
static String	VALUE_COMPONENT	the identifier for the component.
static String	VALUE_DISTRIBUTION	the identifier for the class distribution.
static String	VALUE_EVALUATIONS	the identifier for the evaluations.
static String	VALUE_EVALUATOR	the identifier for the evaluatior.
static String	VALUE_ID	the identifier for the (optional) ID.
static String	VALUE_INSTANCE	the identifier for the instance.
static String	VALUE_INSTANCES	the identifier for the instances.
static String	VALUE_VERSION	the identifier for the version.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Fields inherited from interface adams.flow.container.ContainerWithReport

VALUE_REPORT

Constructor Summary

Constructors

Constructor	Description
EvaluationContainer()	Default constructor.
EvaluationContainer(weka.core.Instance inst)	Initializes the container with the WEKA instance.
EvaluationContainer(weka.core.Instance inst, Map<String,Object> evaluations)	Initializes the container with the WEKA instance.
EvaluationContainer(weka.core.Instances inst)	Initializes the container with the WEKA instances.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.container.Container

addAdditionalName, addHelp, addHelp, addHelp, getClone, getHelp, getValue, getValue, hasHelp, hasValue, removeAdditionalName, setValue, stored, toSpreadSheet, toString

Methods inherited from interface adams.core.GlobalInfoSupporter

globalInfo

Field Detail

VALUE_INSTANCE

public static final String VALUE_INSTANCE

the identifier for the instance.

See Also:

Constant Field Values

VALUE_CLASSIFICATION

public static final String VALUE_CLASSIFICATION

the identifier for the classification.

See Also:

Constant Field Values

VALUE_ABSTENTION_CLASSIFICATION

public static final String VALUE_ABSTENTION_CLASSIFICATION

the identifier for the classification of an abstaining classifier.

See Also:

Constant Field Values

VALUE_DISTRIBUTION

public static final String VALUE_DISTRIBUTION

the identifier for the class distribution.

See Also:

Constant Field Values

VALUE_INSTANCES

public static final String VALUE_INSTANCES

the identifier for the instances.

See Also:

Constant Field Values

VALUE_EVALUATIONS

public static final String VALUE_EVALUATIONS

the identifier for the evaluations.

See Also:

Constant Field Values

VALUE_EVALUATOR

public static final String VALUE_EVALUATOR

the identifier for the evaluatior.

See Also:

Constant Field Values

VALUE_COMPONENT

public static final String VALUE_COMPONENT

the identifier for the component.

See Also:

Constant Field Values

VALUE_VERSION

public static final String VALUE_VERSION

the identifier for the version.

See Also:

Constant Field Values

VALUE_ID

public static final String VALUE_ID

the identifier for the (optional) ID.

See Also:

Constant Field Values

Constructor Detail

EvaluationContainer

public EvaluationContainer()

Default constructor.

EvaluationContainer

public EvaluationContainer(weka.core.Instance inst)

Initializes the container with the WEKA instance.

Parameters:

inst - the instance

EvaluationContainer

public EvaluationContainer(weka.core.Instance inst,
                           Map<String,Object> evaluations)

Initializes the container with the WEKA instance.

Parameters:

inst - the instance

evaluations - the associated evaluations

EvaluationContainer

public EvaluationContainer(weka.core.Instances inst)

Initializes the container with the WEKA instances.

Parameters:

inst - the instances

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class adams.flow.container.AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface adams.flow.container.Container

Specified by:

names in class adams.flow.container.AbstractContainer

Returns:

enumeration over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface adams.flow.container.Container

Specified by:

isValid in class adams.flow.container.AbstractContainer

Returns:

true if all the necessary values are available