Package adams.flow.container

Class SpreadSheetCellSelectionContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.SpreadSheetCellSelectionContainer

All Implemented Interfaces:

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

public class SpreadSheetCellSelectionContainer
extends AbstractContainer

Container for storing output from the SpreadSheetCellSelector transformer.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_ORIGINAL	the key for the original spreadsheet.
static String	VALUE_SELECTED	the key for the spreadsheet with the selected values.
static String	VALUE_SUBSET	the key for the spreadsheet with the subset of values.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
SpreadSheetCellSelectionContainer()	Default constructor.
SpreadSheetCellSelectionContainer(SpreadSheet original, SpreadSheet selected, SpreadSheet subset)	Initializes the container with the relevant spreadheets.

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 key for the original spreadsheet.

See Also:

Constant Field Values

VALUE_SELECTED

public static final String VALUE_SELECTED

the key for the spreadsheet with the selected values.

See Also:

Constant Field Values

VALUE_SUBSET

public static final String VALUE_SUBSET

the key for the spreadsheet with the subset of values.

See Also:

Constant Field Values

Constructor Detail

SpreadSheetCellSelectionContainer

public SpreadSheetCellSelectionContainer()

Default constructor.

SpreadSheetCellSelectionContainer

public SpreadSheetCellSelectionContainer(SpreadSheet original,
                                         SpreadSheet selected,
                                         SpreadSheet subset)

Initializes the container with the relevant spreadheets.

Parameters:

original - the original spreadsheet

selected - the X/Y coordinates and values of the selected cells

subset - the spreadsheet with only the selected cells remaining

Method Detail

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

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

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