Package adams.flow.control

Interface ScopeHandler

All Superinterfaces:

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

All Known Subinterfaces:

LocalScopeHandler

All Known Implementing Classes:

Flow, LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger

public interface ScopeHandler
extends ActorHandler

For actors that define a scope like the Flow or LocalScopeTrigger actor.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ScopeHandler.ScopeHandling	Enumer for how the scope is being handled.

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
String	addCallableName(ActorHandler handler, Actor actor)	Adds the callable name to the list of used ones.
boolean	getEnforceCallableNameCheck()	Returns whether the check of callable names is enforced.
boolean	isCallableNameUsed(ActorHandler handler, Actor actor)	Checks whether a callable name is already in use.
void	setEnforceCallableNameCheck(boolean value)	Sets whether to enforce the callable name check.

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

Methods inherited from interface adams.flow.core.ActorHandler

check, firstActive, flushExecution, get, getActorHandlerInfo, indexOf, lastActive, set, size

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, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

setEnforceCallableNameCheck

void setEnforceCallableNameCheck(boolean value)

Sets whether to enforce the callable name check.

Parameters:

value - true if to enforce check

getEnforceCallableNameCheck

boolean getEnforceCallableNameCheck()

Returns whether the check of callable names is enforced.

Returns:

true if check enforced

isCallableNameUsed

boolean isCallableNameUsed(ActorHandler handler,
                           Actor actor)

Checks whether a callable name is already in use.

Parameters:

handler - the handler for the actor

actor - the actor name to check

See Also:

getEnforceCallableNameCheck()

addCallableName

String addCallableName(ActorHandler handler,
                       Actor actor)

Adds the callable name to the list of used ones.

Parameters:

handler - the handler for the actor

actor - the actor name to add

Returns:

null if successfully added, otherwise error message

See Also:

getEnforceCallableNameCheck()