Package adams.flow.container

Class OutlierContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.OutlierContainer

All Implemented Interfaces:

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

public class OutlierContainer
extends AbstractContainer

A container for outlier 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_CLEAN	the identifier for the cleaned up data.
static String	VALUE_ORIGINAL	the identifier for the original data.
static String	VALUE_OUTLIERS	the identifier for the outlier data.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
OutlierContainer()	Initializes the container.
OutlierContainer(SpreadSheet original, SpreadSheet clean, SpreadSheet outliers)	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_ORIGINAL

public static final String VALUE_ORIGINAL

the identifier for the original data.

See Also:

Constant Field Values

VALUE_CLEAN

public static final String VALUE_CLEAN

the identifier for the cleaned up data.

See Also:

Constant Field Values

VALUE_OUTLIERS

public static final String VALUE_OUTLIERS

the identifier for the outlier data.

See Also:

Constant Field Values

Constructor Detail

OutlierContainer

public OutlierContainer()

Initializes the container.

Only used for generating help information.

OutlierContainer

public OutlierContainer(SpreadSheet original,
                        SpreadSheet clean,
                        SpreadSheet outliers)

Initializes the container with no header.

Parameters:

original - the original data

clean - the clean data, can be null

outliers - 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