Package adams.flow.core

Interface ActorReferenceHandler

All Superinterfaces:

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

All Known Implementing Classes:

AbstractMultiView, CallableActors, GridView, TabView

public interface ActorReferenceHandler
extends MutableActorHandler

Interface for actors that manage callable actors.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
String	checkActorReferenceHandlers()	Ensures that the handlers appear in the correct order.
Class[]	getProhibitedPrecedingActorReferenceHandlers()	Returns the classes that are prohibited to appear before this reference handler.
boolean	isReferencingRequired()	Returns whether actors have to be referenced elsewhere in the flow or whether it is optional.

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.flow.core.MutableActorHandler

add, add, remove, removeAll

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

getProhibitedPrecedingActorReferenceHandlers

Class[] getProhibitedPrecedingActorReferenceHandlers()

Returns the classes that are prohibited to appear before this reference handler.

Returns:

the classes

checkActorReferenceHandlers

String checkActorReferenceHandlers()

Ensures that the handlers appear in the correct order.

Returns:

null if OK, otherwise error message

See Also:

getProhibitedPrecedingActorReferenceHandlers()

isReferencingRequired

boolean isReferencingRequired()

Returns whether actors have to be referenced elsewhere in the flow or whether it is optional.

Returns:

true if required, false if optional