Package adams.gui.flow.tree

Class ClipboardActorContainer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.gui.flow.tree.ClipboardActorContainer

All Implemented Interfaces:

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

public class ClipboardActorContainer
extends AbstractActor
implements MutableActorHandler

A simple container for multiple actors, for easy copying to and retrieving from the clipboard.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<Actor>	m_Actors	the actors.

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
ClipboardActorContainer()

Method Summary

Modifier and Type	Method	Description
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".
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Does nothing.
Actor	firstActive()	Returns the first non-skipped actor.
void	flushExecution()	Stops the processing of tokens without stopping the flow.
static ClipboardActorContainer	fromNestedString(String s)	Creates, if possible, an actor container from the given string (in nested format).
Actor	get(int index)	Returns the actor at the given position.
ActorHandlerInfo	getActorHandlerInfo()	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
Actor[]	getActors()	Returns the actors as array.
String	globalInfo()	Returns a string describing the object.
int	indexOf(String actor)	Returns the index of the actor.
protected void	initialize()	Initializes the members.
Actor	lastActive()	Returns the last non-skipped actor.
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 actors.
void	setVariables(Variables value)	Updates the Variables instance in use.
int	size()	Returns the size of the group.
String	toNestedString()	Returns a string representation of the options.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, 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, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, 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

cleanUp, 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, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

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 ArrayList<Actor> m_Actors

the actors.

Constructor Detail

ClipboardActorContainer

public ClipboardActorContainer()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

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 AbstractActor

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

Returns:

the info

check

public String check()

Performs checks on the "sub-actors".

Specified by:

check in interface ActorHandler

Returns:

always null

size

public int size()

Returns the size of the group.

Specified by:

size in interface ActorHandler

Returns:

the size

get

public Actor get(int index)

Returns the actor at the given position.

Specified by:

get in interface ActorHandler

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

Parameters:

index - the position

actor - the actor to set at this position

Returns:

null if everything is fine, otherwise the error

indexOf

public int indexOf(String actor)

Returns the index of the actor.

Specified by:

indexOf in interface ActorHandler

Parameters:

actor - the name of the actor to look for

Returns:

the index of -1 if not found

firstActive

public Actor firstActive()

Returns the first non-skipped actor.

Specified by:

firstActive in interface ActorHandler

Returns:

the first 'active' actor, null if none available

lastActive

public Actor lastActive()

Returns the last non-skipped actor.

Specified by:

lastActive in interface ActorHandler

Returns:

the last 'active' actor, null if none available

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

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

setActors

public void setActors(Actor[] value)

Sets the actors. Replaces all previous actors.

Parameters:

value - the actors to set

getActors

public Actor[] getActors()

Returns the actors as array.

Returns:

the actors

actorsTipText

public 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.

setVariables

public void setVariables(Variables value)

Updates the Variables instance in use.

Use with caution!

Specified by:

setVariables in interface Actor

Overrides:

setVariables in class AbstractActor

Parameters:

value - the instance to use

See Also:

AbstractActor.forceVariables(Variables)

doExecute

protected String doExecute()

Does nothing.

Specified by:

doExecute in class AbstractActor

Returns:

always null

flushExecution

public void flushExecution()

Stops the processing of tokens without stopping the flow.

Specified by:

flushExecution in interface ActorHandler

Specified by:

flushExecution in interface Flushable

toNestedString

public String toNestedString()

Returns a string representation of the options.

Returns:

a string representation

fromNestedString

public static ClipboardActorContainer fromNestedString(String s)

Creates, if possible, an actor container from the given string (in nested format).

Parameters:

s - the string parse

Returns:

the parsed actor or null if not possible