adams.flow.sink
Class TemplateSink

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.core.AbstractTemplate
                  adams.flow.sink.TemplateSink

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable

public class TemplateSink
extends AbstractTemplate
implements InputConsumer

Lets a sink generated from a template consume the input tokens.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

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

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

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

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

-template <adams.flow.template.AbstractActorTemplate> (property: template)
    The template to use for generating the actual actor.
    default: adams.flow.template.DummySink
 

Version:

$Revision: 5261 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

static String	BACKUP_CURRENT the key for storing the current counter in the backup.
protected Token	m_CurrentInput the token that is to be fed to the global sink.

Fields inherited from class adams.flow.core.AbstractTemplate

BACKUP_ACTOR, m_Actor, m_Template

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_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

TemplateSink()

Method Summary

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.
protected String	doExecute() Executes the flow item.
protected AbstractActorTemplate	getDefaultTemplate() Returns the default template to use.
String	globalInfo() Returns a string describing the object.
void	input(Token token) The method that accepts the input token and then processes it.
protected void	reset() Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state) Restores the state of the actor before the variables got updated.
protected String	setUpTemplate() Initializes the template for flow execution.

Methods inherited from class adams.flow.core.AbstractTemplate

cleanUp, defineOptions, getActualActor, getQuickInfo, getTemplate, isFinished, pruneBackup, setTemplate, stopExecution, templateTipText, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

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, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Field Detail

BACKUP_CURRENT

public static final String BACKUP_CURRENT

the key for storing the current counter in the backup.

See Also:

Constant Field Values

m_CurrentInput

protected transient Token m_CurrentInput

the token that is to be fed to the global sink.

Constructor Detail

TemplateSink

public TemplateSink()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractTemplate

getDefaultTemplate

protected AbstractActorTemplate getDefaultTemplate()

Returns the default template to use.

Specified by:

getDefaultTemplate in class AbstractTemplate

Returns:

the template

backupState

protected Hashtable<String,Object> backupState()

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

Overrides:

backupState in class AbstractTemplate

Returns:

the backup

restoreState

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

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

Overrides:

restoreState in class AbstractTemplate

Parameters:

state - the backup of the state to restore from

setUpTemplate

protected String setUpTemplate()

Initializes the template for flow execution.

Overrides:

setUpTemplate in class AbstractTemplate

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

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message