Package adams.flow.container

Class PredictionEccentricityContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.PredictionEccentricityContainer

All Implemented Interfaces:

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

public class PredictionEccentricityContainer
extends AbstractContainer

A container for prediction eccentricity data.

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_ECCENTRICITY	the identifier for the calculated eccentricity.
static String	VALUE_MATRIX	the identifier for the binary matrix used to calculate the eccentricity.
static String	VALUE_PREDICTIONS	the identifier for the underlying predictions.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
PredictionEccentricityContainer()	Initializes the container.
PredictionEccentricityContainer(SpreadSheet predictions, Double eccentricity, BooleanArrayMatrixView matrix)	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_PREDICTIONS

public static final String VALUE_PREDICTIONS

the identifier for the underlying predictions.

See Also:

Constant Field Values

VALUE_ECCENTRICITY

public static final String VALUE_ECCENTRICITY

the identifier for the calculated eccentricity.

See Also:

Constant Field Values

VALUE_MATRIX

public static final String VALUE_MATRIX

the identifier for the binary matrix used to calculate the eccentricity.

See Also:

Constant Field Values

Constructor Detail

PredictionEccentricityContainer

public PredictionEccentricityContainer()

Initializes the container.

Only used for generating help information.

PredictionEccentricityContainer

public PredictionEccentricityContainer(SpreadSheet predictions,
                                       Double eccentricity,
                                       BooleanArrayMatrixView matrix)

Initializes the container with no header.

Parameters:

predictions - the original data

clean - the clean data, can be null

matrix - the outlier data, 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