Package adams.flow.container

Class WekaClusterEvaluationContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.WekaClusterEvaluationContainer

All Implemented Interfaces:

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

public class WekaClusterEvaluationContainer
extends adams.flow.container.AbstractContainer

A container for ClusterEvaluation 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 ClusterEvaluation.
static String	VALUE_LOGLIKELIHOOD	the identifier for the log-likelihood.
static String	VALUE_MODEL	the identifier for the Model.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
WekaClusterEvaluationContainer()	Initializes the container.
WekaClusterEvaluationContainer(double logLikelihood)	Initializes the container with the log-likelihood.
WekaClusterEvaluationContainer(weka.clusterers.ClusterEvaluation eval)	Initializes the container.
WekaClusterEvaluationContainer(weka.clusterers.ClusterEvaluation eval, Object model)	Initializes the container.

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 ClusterEvaluation.

See Also:

Constant Field Values

VALUE_MODEL

public static final String VALUE_MODEL

the identifier for the Model.

See Also:

Constant Field Values

VALUE_LOGLIKELIHOOD

public static final String VALUE_LOGLIKELIHOOD

the identifier for the log-likelihood.

See Also:

Constant Field Values

Constructor Detail

WekaClusterEvaluationContainer

public WekaClusterEvaluationContainer()

Initializes the container.

Only used for generating help information.

WekaClusterEvaluationContainer

public WekaClusterEvaluationContainer(weka.clusterers.ClusterEvaluation eval)

Initializes the container.

Parameters:

eval - the evaluation to use

WekaClusterEvaluationContainer

public WekaClusterEvaluationContainer(weka.clusterers.ClusterEvaluation eval,
                                      Object model)

Initializes the container.

Parameters:

eval - the evaluation to use

model - the model to use

WekaClusterEvaluationContainer

public WekaClusterEvaluationContainer(double logLikelihood)

Initializes the container with the log-likelihood.

Parameters:

logLikelihood - the log-likelihood

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