Package adams.flow.container

Class WekaEvaluationContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.WekaEvaluationContainer

All Implemented Interfaces:

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

public class WekaEvaluationContainer
extends adams.flow.container.AbstractContainer

A container for Evaluation objects, with optional trained model.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_EVALUATION	the identifier for the Evaluation.
static String	VALUE_MODEL	the identifier for the Model.
static String	VALUE_ORIGINALINDICES	the identifier for the original indices.
static String	VALUE_PREDICTIONOUTPUT	the identifier for the prediction output.
static String	VALUE_TESTDATA	the identifier for the original data.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
WekaEvaluationContainer()	Initializes the container.
WekaEvaluationContainer(weka.classifiers.Evaluation eval)	Initializes the container with no header.
WekaEvaluationContainer(weka.classifiers.Evaluation eval, Object model)	Initializes the container with no header.
WekaEvaluationContainer(weka.classifiers.Evaluation eval, Object model, String predOutput)	Initializes the container with no header.
WekaEvaluationContainer(weka.classifiers.Evaluation eval, Object model, String predOutput, int[] originalIndices)	Initializes the container with no header.

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

Field Detail

VALUE_EVALUATION

public static final String VALUE_EVALUATION

the identifier for the Evaluation.

See Also:

Constant Field Values

VALUE_MODEL

public static final String VALUE_MODEL

the identifier for the Model.

See Also:

Constant Field Values

VALUE_PREDICTIONOUTPUT

public static final String VALUE_PREDICTIONOUTPUT

the identifier for the prediction output.

See Also:

Constant Field Values

VALUE_ORIGINALINDICES

public static final String VALUE_ORIGINALINDICES

the identifier for the original indices.

See Also:

Constant Field Values

VALUE_TESTDATA

public static final String VALUE_TESTDATA

the identifier for the original data.

See Also:

Constant Field Values

Constructor Detail

WekaEvaluationContainer

public WekaEvaluationContainer()

Initializes the container.

Only used for generating help information.

WekaEvaluationContainer

public WekaEvaluationContainer(weka.classifiers.Evaluation eval)

Initializes the container with no header.

Parameters:

eval - the evaluation to use

WekaEvaluationContainer

public WekaEvaluationContainer(weka.classifiers.Evaluation eval,
                               Object model)

Initializes the container with no header.

Parameters:

eval - the evaluation to use

model - the model to use

WekaEvaluationContainer

public WekaEvaluationContainer(weka.classifiers.Evaluation eval,
                               Object model,
                               String predOutput)

Initializes the container with no header.

Parameters:

eval - the evaluation to use

model - the model to use, can be null

predOutput - the prediction output string, can be null

WekaEvaluationContainer

public WekaEvaluationContainer(weka.classifiers.Evaluation eval,
                               Object model,
                               String predOutput,
                               int[] originalIndices)

Initializes the container with no header.

Parameters:

eval - the evaluation to use

model - the model to use, can be null

predOutput - the prediction output string, can be null

originalIndices - the original indices (for tracing the predictions), can be null

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