Package adams.flow.sink

Class ExternalSink

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

adams.flow.sink.ExternalSink

All Implemented Interfaces:

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

public class ExternalSink
extends AbstractExternalActor
implements InputConsumer

Sink that executes an external sink actor stored on disk.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: ExternalSink
 

-annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 

-file <adams.core.io.FlowFile> (property: actorFile)
    The file containing the external actor.
    default: ${CWD}
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKUP_INPUT	the key for storing the input token in the backup.
protected Token	m_InputToken	the current input token.

Fields inherited from class adams.flow.core.AbstractExternalActor

m_ActorFileChanged, m_ActorFileIsVariable, m_ActorFileVariable, m_ExternalActor, m_Monitor, m_OnTheFly

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
protected Hashtable<String,Object>	backupState()	Backs up the current state of the actor before update the variables.
Token	currentInput()	Returns the current input token, if any.
String	globalInfo()	Returns a string describing the object.
boolean	hasInput()	Returns whether an input token is currently present.
void	input(Token token)	The method that accepts the input token and then processes it.
protected String	preExecuteExternalActorHook()	Gets called in the doExceute() method, after an optional setUpExternalActor() call (in case a variable is used for the actor file), but before the external actor's execute() method is called.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
String	setUpExternalActor()	Sets up the external actor.

Methods inherited from class adams.flow.core.AbstractExternalActor

cleanUp, cleanUpExternalActor, defineOptions, doExecute, forceVariables, getExternalActor, getMonitor, getOnTheFly, getQuickInfo, monitorTipText, onTheFlyTipText, setMonitor, setOnTheFly, setParent, setUp, stopExecution, variableChanged, wrapUp

Methods inherited from class adams.flow.core.AbstractBaseExternalActor

actorFileTipText, getActorFile, getActualActorFile, isModifyingStructure, setActorFile

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, 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, setAnnotations, setErrorHandler, setName, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables

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

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.flow.core.ExternalActorFileHandler

getActorFile, setActorFile

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

Field Detail

BACKUP_INPUT

public static final String BACKUP_INPUT

the key for storing the input token in the backup.

See Also:

Constant Field Values

m_InputToken

protected transient Token m_InputToken

the current input token.

Constructor Detail

ExternalSink

public ExternalSink()

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

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractActor

Returns:

the backup

See Also:

AbstractActor.updateVariables(), AbstractActor.restoreState(Hashtable)

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractActor

Parameters:

state - the backup of the state to restore from

See Also:

AbstractActor.updateVariables(), AbstractActor.backupState()

setUpExternalActor

public String setUpExternalActor()

Sets up the external actor.

Specified by:

setUpExternalActor in interface ExternalActorHandler

Overrides:

setUpExternalActor in class AbstractExternalActor

Returns:

null if everything is fine, otherwise error message

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

the Class of objects that can be processed

input

public void input(Token token)

The method that accepts the input token and then processes it.

Specified by:

input in interface InputConsumer

Parameters:

token - the token to accept and process

hasInput

public boolean hasInput()

Returns whether an input token is currently present.

Specified by:

hasInput in interface InputConsumer

Returns:

true if input token present

currentInput

public Token currentInput()

Returns the current input token, if any.

Specified by:

currentInput in interface InputConsumer

Returns:

the input token, null if none present

preExecuteExternalActorHook

protected String preExecuteExternalActorHook()

Gets called in the doExceute() method, after an optional setUpExternalActor() call (in case a variable is used for the actor file), but before the external actor's execute() method is called.

Sets the input token.

Overrides:

preExecuteExternalActorHook in class AbstractExternalActor

Returns:

null if everything ok, otherwise error message

See Also:

AbstractExternalActor.doExecute(), AbstractExternalActor.setUpExternalActor()