Package adams.flow.container

Class WekaModelContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.WekaModelContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

WekaAssociatorContainer

public class WekaModelContainer
extends adams.flow.container.AbstractContainer

A container for models (e.g., classifier or clusterer) and an optional header of a dataset.

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_DATASET	the identifier for the full dataset.
static String	VALUE_HEADER	the identifier for the Header.
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
WekaModelContainer()	Initializes the container.
WekaModelContainer(Object model)	Initializes the container with no header.
WekaModelContainer(Object model, weka.core.Instances header)	Initializes the container with no header.
WekaModelContainer(Object model, weka.core.Instances header, weka.core.Instances data)	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_MODEL

public static final String VALUE_MODEL

the identifier for the Model.

See Also:

Constant Field Values

VALUE_HEADER

public static final String VALUE_HEADER

the identifier for the Header.

See Also:

Constant Field Values

VALUE_DATASET

public static final String VALUE_DATASET

the identifier for the full dataset.

See Also:

Constant Field Values

Constructor Detail

WekaModelContainer

public WekaModelContainer()

Initializes the container.

Only used for generating help information.

WekaModelContainer

public WekaModelContainer(Object model)

Initializes the container with no header.

Parameters:

model - the model to use

WekaModelContainer

public WekaModelContainer(Object model,
                          weka.core.Instances header)

Initializes the container with no header.

Parameters:

model - the model to use

header - the header to use

WekaModelContainer

public WekaModelContainer(Object model,
                          weka.core.Instances header,
                          weka.core.Instances data)

Initializes the container with no header.

Parameters:

model - the model to use

header - the header to use

data - the data to use

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