Package adams.flow.standalone

Class AbstractMutableStandaloneGroupItem<T extends Actor>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.control.AbstractControlActor

adams.flow.standalone.AbstractMutableStandaloneGroupItem<T>

Type Parameters:

T - the type of the enclosing group

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, Actor, ActorHandler, ControlActor, ErrorHandler, Flushable, MutableActorHandler, SubFlowWrapUp, StandaloneGroupItem<T>, Serializable, Comparable

public abstract class AbstractMutableStandaloneGroupItem<T extends Actor>
extends AbstractControlActor
implements MutableActorHandler, StandaloneGroupItem<T>

Ancestor for group items that can contain other actors.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MutableActorHandler	m_Actors	the flow items.

Fields inherited from class adams.flow.control.AbstractControlActor

m_Compatibility, m_PauseStateManager, m_SetUpSubActors

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
AbstractMutableStandaloneGroupItem()

Method Summary

Modifier and Type	Method	Description
abstract String	actorsTipText()	Returns the tip text for this property.
String	add(int index, Actor actor)	Inserts the actor at the given position.
String	add(Actor actor)	Inserts the actor at the end.
String	check()	Performs checks on the "sub-actors".
protected String	checkSubActor(int index, Actor actor)	Checks the sub actor before it is set.
protected String	checkSubActors(Actor[] actors)	Checks the sub actors before they are set via the setSubActors method.
void	cleanUp()	Cleans up after the execution has finished.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
protected abstract String	doSetUpSubActors()	Gets called in the setUp() method.
Actor	get(int index)	Returns the actor at the given position.
protected Class[]	getActorFilter()	Returns the classes that the flow editor uses for filtering.
ActorHandlerInfo	getActorHandlerInfo()	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
Actor[]	getActors()	Returns the sub actors.
T	getEnclosingGroup()	Returns the enclosing group.
protected MutableActorHandler	getInternalActors()	Returns the internal representation of the actors.
int	indexOf(String actor)	Returns the index of the actor.
protected void	initialize()	Initializes the members.
protected abstract MutableActorHandler	newActorHandler()	Creates an instance of the actor handler taking care of the sub-actors.
Actor	remove(int index)	Removes the actor at the given position and returns the removed object.
void	removeAll()	Removes all actors.
String	set(int index, Actor actor)	Sets the actor at the given position.
void	setActors(Actor[] value)	Sets the sub-actor.
void	setLoggingLevel(LoggingLevel value)	Sets the logging level.
protected String	setUpSubActors()	Performs the setUp of the sub-actors.
int	size()	Returns the size of the group.
protected void	updateParent()	Updates the parent of all actors in this group.

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, flushExecution, forceVariables, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, preExecute, reset, resumeExecution, setParent, setUp, stopExecution, wrapUp, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canPerformSetUpCheck, compareTo, configureLogger, equals, execute, finalUpdateVariables, findVariables, findVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.flow.core.ActorHandler

firstActive, flushExecution, lastActive

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_Actors

protected MutableActorHandler m_Actors

the flow items.

Constructor Detail

AbstractMutableStandaloneGroupItem

public AbstractMutableStandaloneGroupItem()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractControlActor

newActorHandler

protected abstract MutableActorHandler newActorHandler()

Creates an instance of the actor handler taking care of the sub-actors.

Returns:

the handler

setLoggingLevel

public void setLoggingLevel(LoggingLevel value)

Sets the logging level.

Specified by:

setLoggingLevel in interface LoggingLevelHandler

Overrides:

setLoggingLevel in class AbstractOptionHandler

Parameters:

value - the level

getEnclosingGroup

public T getEnclosingGroup()

Returns the enclosing group.

Specified by:

getEnclosingGroup in interface StandaloneGroupItem<T extends Actor>

Returns:

the group, null if not available (eg if parent not set)

check

public String check()

Performs checks on the "sub-actors".

Specified by:

check in interface ActorHandler

Overrides:

check in class AbstractControlActor

Returns:

null if checks passed or null in case of an error

checkSubActor

protected String checkSubActor(int index,
                               Actor actor)

Checks the sub actor before it is set. Returns an error message if the actor is not acceptable, null otherwise.

Parameters:

index - the index the actor gets set

actor - the actor to check

Returns:

null if accepted, otherwise error message

checkSubActors

protected String checkSubActors(Actor[] actors)

Checks the sub actors before they are set via the setSubActors method. Returns an error message if the actors are not acceptable, null otherwise.

Parameters:

actors - the actors to check

Returns:

null if accepted, otherwise error message

setActors

public void setActors(Actor[] value)

Sets the sub-actor.

Parameters:

value - the actor

getActors

public Actor[] getActors()

Returns the sub actors.

Returns:

the actors

actorsTipText

public abstract String actorsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

updateParent

protected void updateParent()

Updates the parent of all actors in this group.

Overrides:

updateParent in class AbstractControlActor

size

public int size()

Returns the size of the group.

Specified by:

size in interface ActorHandler

Specified by:

size in class AbstractControlActor

Returns:

always 1

get

public Actor get(int index)

Returns the actor at the given position.

Specified by:

get in interface ActorHandler

Specified by:

get in class AbstractControlActor

Parameters:

index - the position

Returns:

the actor

set

public String set(int index,
                  Actor actor)

Sets the actor at the given position.

Specified by:

set in interface ActorHandler

Specified by:

set in class AbstractControlActor

Parameters:

index - the position

actor - the actor to set at this position

Returns:

null if everything is fine, otherwise the error

See Also:

checkSubActor(int, Actor)

indexOf

public int indexOf(String actor)

Returns the index of the actor.

Specified by:

indexOf in interface ActorHandler

Specified by:

indexOf in class AbstractControlActor

Parameters:

actor - the name of the actor to look for

Returns:

the index of -1 if not found

add

public String add(Actor actor)

Inserts the actor at the end.

Specified by:

add in interface MutableActorHandler

Parameters:

actor - the actor to insert

Returns:

null if everything is fine, otherwise the error

add

public String add(int index,
                  Actor actor)

Inserts the actor at the given position.

Specified by:

add in interface MutableActorHandler

Parameters:

index - the position

actor - the actor to insert

Returns:

null if everything is fine, otherwise the error

See Also:

checkSubActor(int, Actor)

remove

public Actor remove(int index)

Removes the actor at the given position and returns the removed object.

Specified by:

remove in interface MutableActorHandler

Parameters:

index - the position

Returns:

the removed actor

removeAll

public void removeAll()

Removes all actors.

Specified by:

removeAll in interface MutableActorHandler

getInternalActors

protected MutableActorHandler getInternalActors()

Returns the internal representation of the actors.

Returns:

the internal actors

getActorFilter

protected Class[] getActorFilter()

Returns the classes that the flow editor uses for filtering.
Default implementation returns null.

Returns:

the classes, null if to use default from underlying actor handler

getActorHandlerInfo

public ActorHandlerInfo getActorHandlerInfo()

Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.

Specified by:

getActorHandlerInfo in interface ActorHandler

Specified by:

getActorHandlerInfo in class AbstractControlActor

Returns:

the info

doSetUpSubActors

protected abstract String doSetUpSubActors()

Gets called in the setUp() method. Returns null if sub-actors are fine, otherwise error message.

Returns:

null if everything OK, otherwise error message

setUpSubActors

protected String setUpSubActors()

Performs the setUp of the sub-actors.

Overrides:

setUpSubActors in class AbstractControlActor

Returns:

null if everything is fine, otherwise error message

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

cleanUp

public void cleanUp()

Cleans up after the execution has finished. Also removes graphical components.

Specified by:

cleanUp in interface Actor

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractControlActor