Package adams.flow.container

Class AbstractFilterContainer<F extends Filter,D extends DataContainer>

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.AbstractFilterContainer<F,D>

Type Parameters:

F - the type of filter

D - the type of data

All Implemented Interfaces:

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

Direct Known Subclasses:

TimeseriesFilterContainer

public class AbstractFilterContainer<F extends Filter,D extends DataContainer>
extends AbstractContainer

A container for filters and the filtered data.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_DATA	the identifier for the Data.
static String	VALUE_FILTER	the identifier for the Filter.
static String	VALUE_INPUT	the identifier for the Input Data.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
AbstractFilterContainer()	Initializes the container.
AbstractFilterContainer(Object input, F filter, D data)	Initializes the container with the filter and the associated data.

Method Summary

Modifier and Type	Method	Description
protected void	initFilterHelp()	Initializes help strings specific to the filter.
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_FILTER

public static final String VALUE_FILTER

the identifier for the Filter.

See Also:

Constant Field Values

VALUE_DATA

public static final String VALUE_DATA

the identifier for the Data.

See Also:

Constant Field Values

VALUE_INPUT

public static final String VALUE_INPUT

the identifier for the Input Data.

See Also:

Constant Field Values

Constructor Detail

AbstractFilterContainer

public AbstractFilterContainer()

Initializes the container.

Only used for generating help information.

AbstractFilterContainer

public AbstractFilterContainer(Object input,
                               F filter,
                               D data)

Initializes the container with the filter and the associated data.

Parameters:

input - the input data

filter - the filter

data - the dataset, can be null

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

initFilterHelp

protected void initFilterHelp()

Initializes help strings specific to the filter.

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