AbstractIncludeExternalActor (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractActor
      - adams.flow.core.AbstractBaseExternalActor
        
        adams.flow.core.AbstractIncludeExternalActor

All Implemented Interfaces:

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

Direct Known Subclasses:

IncludeExternalSink, IncludeExternalSource, IncludeExternalStandalone, IncludeExternalTransformer
```
public abstract class AbstractIncludeExternalActor
extends AbstractBaseExternalActor
```
Ancestor for actors that get replaced with the externally stored actor.

Version:

$Revision: 9391 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.flow.core.AbstractBaseExternalActor
  m_ActorFile
- 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

AbstractIncludeExternalActor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract String`	`checkExternalActor(Actor actor)`	Performs checks on the external actor.
`protected String`	`doExecute()`	Executes the flow item.
`String`	`setUp()`	Initializes the item for flow execution.
`String`	`setUpExternalActor()`	Sets up the external actor.

Methods inherited from class adams.flow.core.AbstractBaseExternalActor
actorFileTipText, defineOptions, getActorFile, getActualActorFile, getQuickInfo, isModifyingStructure, setActorFile

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, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, 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, globalInfo, 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.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

- Constructor Detail
  - AbstractIncludeExternalActor
```
public AbstractIncludeExternalActor()
```
- Method Detail
  - checkExternalActor
```
protected abstract String checkExternalActor(Actor actor)
```
    Performs checks on the external actor.
    
    Parameters:
    
    actor - the actor to check
    
    Returns:
    
    null if OK, otherwise error message
  - setUpExternalActor
```
public String setUpExternalActor()
```
    Sets up the external actor.
    
    Returns:
    
    null if everything is fine, otherwise error message
  - setUp
```
public String setUp()
```
    Initializes the item for flow execution.
    
    Specified by:
    
    setUp in interface Actor
    
    Overrides:
    
    setUp in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message
    
    See Also:
    
    AbstractActor.reset()
  - doExecute
```
protected String doExecute()
```
    Executes the flow item.
    
    Specified by:
    
    doExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message