Package adams.flow.transformer

Class ExecuteActor

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, FlowExecutionListeningSupporter, Serializable, Comparable
    public class ExecuteActor
extends AbstractTransformer
implements FlowExecutionListeningSupporter
    Executes the actor passing through and forwards it once finished.
    If the actor is an instance of adams.flow.execution.FlowExecutionListeningSupporter and flow execution listening enabled, then the specified flow execution listener gets attached. 

    -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: ExecuteActor
 
    -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 execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -call-setup <boolean> (property: callSetUp)
    If enabled, the actor's 'setUp()' method gets called.
    default: false
 
    -call-wrapup <boolean> (property: callWrapUp)
    If enabled, the actor's 'wrapUp()' method gets called.
    default: false
 
    -call-cleanup <boolean> (property: callCleanUp)
    If enabled, the actor's 'cleanUp()' method gets called.
    default: false
 
    -flow-execution-listening-enabled <boolean> (property: flowExecutionListeningEnabled)
    Enables/disables the flow execution listener.
    default: false
 
    -flow-execution-listener <adams.flow.execution.FlowExecutionListener> (property: flowExecutionListener)
    The listener for the flow execution; must be enabled explicitly.
    default: adams.flow.execution.NullListener
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CallSetUp

        protected boolean m_CallSetUp
        whether to call the setUp method.

      • m_CallWrapUp

        protected boolean m_CallWrapUp
        whether to call the wrapUp method.

      • m_CallCleanUp

        protected boolean m_CallCleanUp
        whether to call the cleanUp method.

      • m_Actor

        protected transient Actor m_Actor
        the current actor being executed.

      • m_FlowExecutionListeningEnabled

        protected boolean m_FlowExecutionListeningEnabled
        whether flow execution listening is enabled.

      • m_FlowExecutionListener

        protected FlowExecutionListener m_FlowExecutionListener
        the execution listener to use.

    • Constructor Detail

      • ExecuteActor

        public ExecuteActor()

    • Method Detail

      • setCallSetUp

        public void setCallSetUp​(boolean value)
        Sets whether to call the actor's setUp method.
        Parameters:
        value - true if to call

      • getCallSetUp

        public boolean getCallSetUp()
        Returns whether to call the actor's setUp method.
        Returns:
        true if to call

      • callSetUpTipText

        public String callSetUpTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setCallWrapUp

        public void setCallWrapUp​(boolean value)
        Sets whether to call the actor's wrapUp method.
        Parameters:
        value - true if to call

      • getCallWrapUp

        public boolean getCallWrapUp()
        Returns whether to call the actor's wrapUp method.
        Returns:
        true if to call

      • callWrapUpTipText

        public String callWrapUpTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setCallCleanUp

        public void setCallCleanUp​(boolean value)
        Sets whether to call the actor's cleanUp method.
        Parameters:
        value - true if to call

      • getCallCleanUp

        public boolean getCallCleanUp()
        Returns whether to call the actor's cleanUp method.
        Returns:
        true if to call

      • callCleanUpTipText

        public String callCleanUpTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • flowExecutionListeningEnabledTipText

        public String flowExecutionListeningEnabledTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • flowExecutionListenerTipText

        public String flowExecutionListenerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message