Package adams.flow.container

Class WekaExperimentContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.WekaExperimentContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class WekaExperimentContainer
extends AbstractContainer

Container for Weka experiment results.

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_EXPERIMENT	the identifier for the experiment.
static String	VALUE_INSTANCES	the identifier for the results (instances).
static String	VALUE_SPREADSHEET	the identifier for the results (spreadsheet).

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
WekaExperimentContainer()	Initializes the container.
WekaExperimentContainer(AbstractExperiment exp, weka.core.Instances inst, SpreadSheet sheet)	Initializes the container.
WekaExperimentContainer(weka.core.Instances inst)	Initializes the container with just the 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

Field Detail

VALUE_EXPERIMENT

public static final String VALUE_EXPERIMENT

the identifier for the experiment.

See Also:

Constant Field Values

VALUE_INSTANCES

public static final String VALUE_INSTANCES

the identifier for the results (instances).

See Also:

Constant Field Values

VALUE_SPREADSHEET

public static final String VALUE_SPREADSHEET

the identifier for the results (spreadsheet).

See Also:

Constant Field Values

Constructor Detail

WekaExperimentContainer

public WekaExperimentContainer()

Initializes the container.

Only used for generating help information.

WekaExperimentContainer

public WekaExperimentContainer(weka.core.Instances inst)

Initializes the container with just the Instances.

Parameters:

inst - the experiment results

WekaExperimentContainer

public WekaExperimentContainer(AbstractExperiment exp,
                               weka.core.Instances inst,
                               SpreadSheet sheet)

Initializes the container.

Parameters:

exp - the experiment (can be null)

inst - the experiment results

sheet - the experiment results (can be null)

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

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

Specified by:

names in interface Container

Specified by:

names in class 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 Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available