Package adams.flow.container

Class ControlChartContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.ControlChartContainer

All Implemented Interfaces:

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

public class ControlChartContainer
extends AbstractContainer

Container to store control chart 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_ALGORITHM	the identifier for the algorithm.
static String	VALUE_CHART	the identifier for the chart name.
static String	VALUE_DATA	the identifier for the data (double array).
static String	VALUE_LIMITS	the identifier for the limits (array of Limits).
static String	VALUE_PREPARED	the identifier for the perpared data (double array).

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
ControlChartContainer()	Initializes the container with dummy values.
ControlChartContainer(ControlChart algorithm, String chart, Object data, Object prepared, Limits[] limits)	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_ALGORITHM

public static final String VALUE_ALGORITHM

the identifier for the algorithm.

See Also:

Constant Field Values

VALUE_CHART

public static final String VALUE_CHART

the identifier for the chart name.

See Also:

Constant Field Values

VALUE_DATA

public static final String VALUE_DATA

the identifier for the data (double array).

See Also:

Constant Field Values

VALUE_PREPARED

public static final String VALUE_PREPARED

the identifier for the perpared data (double array).

See Also:

Constant Field Values

VALUE_LIMITS

public static final String VALUE_LIMITS

the identifier for the limits (array of Limits).

See Also:

Constant Field Values

Constructor Detail

ControlChartContainer

public ControlChartContainer()

Initializes the container with dummy values.

Only used for generating help information.

ControlChartContainer

public ControlChartContainer(ControlChart algorithm,
                             String chart,
                             Object data,
                             Object prepared,
                             Limits[] limits)

Initializes the container.

Parameters:

algorithm - the algorithm used for generating the data

chart - the name of the chart, can be null

data - the original data

prepared - the prepared/processed data

limits - the limits

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:

iterator 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