Package adams.flow.container

Class ProcessActorContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.ProcessActorContainer

All Implemented Interfaces:

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

public class ProcessActorContainer
extends AbstractContainer

Container for output from actor processors.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

ActorProcessor, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_ACTOR	the key for the actor.
static String	VALUE_LIST	the key for the list.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
ProcessActorContainer()	Default constructor.
ProcessActorContainer(Actor actor)	Initializes the container with the actor.
ProcessActorContainer(Actor actor, String[] list)	Initializes the container with the actor and list.

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_ACTOR

public static final String VALUE_ACTOR

the key for the actor.

See Also:

Constant Field Values

VALUE_LIST

public static final String VALUE_LIST

the key for the list.

See Also:

Constant Field Values

Constructor Detail

ProcessActorContainer

public ProcessActorContainer()

Default constructor.

ProcessActorContainer

public ProcessActorContainer(Actor actor)

Initializes the container with the actor.

Parameters:

actor - the actor to store

ProcessActorContainer

public ProcessActorContainer(Actor actor,
                             String[] list)

Initializes the container with the actor and list.

Parameters:

actor - the actor to store

list - the list to store, can be null

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