Package adams.flow.source

Class SpecifiedActor

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class SpecifiedActor
extends AbstractSimpleSource
    Outputs the actor identified by the actor path.

    Input/output:
    - generates:
       adams.flow.core.Actor


    -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: SpecifiedActor
 
    -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
 
    -path <adams.flow.core.ActorPath> (property: path)
    The path of the actor to output.
    default:
 
    -expand-variables <boolean> (property: expandVariables)
    If enabled, variables get expanded to their current values.
    default: false
 
    -no-sub-actors <boolean> (property: noSubActors)
    If enabled, actor handlers will have their sub-actors removed.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Path

        protected ActorPath m_Path
        the actor path.

      • m_ExpandVariables

        protected boolean m_ExpandVariables
        whether to expand variables.

      • m_NoSubActors

        protected boolean m_NoSubActors
        whether to exclude any sub-actors (in case of actor handlers).

    • Constructor Detail

      • SpecifiedActor

        public SpecifiedActor()

    • Method Detail

      • setPath

        public void setPath​(ActorPath value)
        Sets the path of the actor to output.
        Parameters:
        value - the path

      • getPath

        public ActorPath getPath()
        Returns the path of the actor to output.
        Returns:
        the path

      • pathTipText

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

      • setExpandVariables

        public void setExpandVariables​(boolean value)
        Sets whether to expand variables using their current values.
        Parameters:
        value - true if to expand

      • getExpandVariables

        public boolean getExpandVariables()
        Returns whether to expand variables using their current values.
        Returns:
        true if to expand

      • expandVariablesTipText

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

      • setNoSubActors

        public void setNoSubActors​(boolean value)
        Sets whether to strip actor handlers of their sub-actors.
        Parameters:
        value - true if to strip sub-actors

      • getNoSubActors

        public boolean getNoSubActors()
        Returns whether to strip actor handlers of their sub-actors.
        Returns:
        true if to strip sub-actors

      • noSubActorsTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        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