Package adams.flow.control

Class ArrayProcess

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, ThreadLimiter, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ActorWithConditionalEquivalent, ActorWithTimedEquivalent, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OptionalStopRestrictor, OutputProducer, PauseStateHandler, StopRestrictor, SubFlowWrapUp, Serializable, Comparable
    public class ArrayProcess
extends SubProcess
implements ThreadLimiter
    Applies all sub-actors to each of the array elements. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ArrayProcess
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -finish-before-stopping <boolean> (property: finishBeforeStopping)
    If enabled, actor first finishes processing all data before stopping.
    default: false
 
    -stopping-timeout <int> (property: stoppingTimeout)
    The timeout in milliseconds when waiting for actors to finish (<= 0 for
    infinity; see 'finishBeforeStopping').
    default: -1
    minimum: -1
 
    -stopping-warning-interval <int> (property: stoppingWarningInterval)
    The interval in milliseconds to output logging warnings if the actors haven't
    stopped yet (and no stopping timeout set); no warning if <= 0.
    default: 10000
    minimum: -1
 
    -actor <adams.flow.core.Actor> [-actor ...] (property: actors)
    All the actors that define this sequence.
    default:
 
    -num-threads <int> (property: numThreads)
    The number of threads to use for parallel execution; > 0: specific number
    of cores to use (capped by actual number of cores available, 1 = sequential
    execution); = 0: number of cores; < 0: number of free cores (eg -2 means
    2 free cores; minimum of one core is used)
    default: 1
 
    -array-class <adams.core.base.BaseClassname> (property: arrayClass)
    The class to use for the array; if none is specified, the class of the first
    element is used.
    default:
 
    -store-element-index <boolean> (property: storeElementIndex)
    If enabled, the element index (1-based) of the current element being processed
    gets stored in the specified variable.
    default: false
 
    -element-index-variable <adams.core.VariableName> (property: elementIndexVariable)
    The variable to store the element index in.
    default: variable
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • BACKUP_OUTPUT

        public static final String BACKUP_OUTPUT
        the key for storing the output token in the backup.
        See Also:
        Constant Field Values

      • m_NumThreads

        protected int m_NumThreads
        the number of threads to use for parallel execution.

      • m_ArrayClass

        protected BaseClassname m_ArrayClass
        the class for the array.

      • m_StoreElementIndex

        protected boolean m_StoreElementIndex
        whether to store the index of the element currently being processed in a variable.

      • m_ElementIndexVariable

        protected VariableName m_ElementIndexVariable
        the variable to store the element index in.

      • m_OutputToken

        protected Token m_OutputToken
        the output array.

    • Constructor Detail

      • ArrayProcess

        public ArrayProcess()

    • Method Detail

      • setNumThreads

        public void setNumThreads​(int value)
        Sets the number of threads to use for executing the branches.
        Specified by:
        setNumThreads in interface ThreadLimiter
        Parameters:
        value - the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution

      • getNumThreads

        public int getNumThreads()
        Returns the number of threads to use for executing the branches.
        Specified by:
        getNumThreads in interface ThreadLimiter
        Returns:
        the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution

      • numThreadsTipText

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

      • setArrayClass

        public void setArrayClass​(BaseClassname value)
        Sets the class for the array.
        Parameters:
        value - the classname, use empty string to use class of first element

      • getArrayClass

        public BaseClassname getArrayClass()
        Returns the class for the array.
        Returns:
        the classname, empty string if class of first element is used

      • arrayClassTipText

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

      • setStoreElementIndex

        public void setStoreElementIndex​(boolean value)
        Sets whether to store the element index in a variable.
        Parameters:
        value - true if the element index should get stored in variable

      • getStoreElementIndex

        public boolean getStoreElementIndex()
        Returns whether to store the element index in a variable.
        Returns:
        true if the element index gets stored in variable

      • storeElementIndexTipText

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

      • setElementIndexVariable

        public void setElementIndexVariable​(VariableName value)
        Sets the variable name to store the current element index in.
        Parameters:
        value - the variable name

      • getElementIndexVariable

        public VariableName getElementIndexVariable()
        Returns the variable name to store the current element index in.
        Returns:
        the variable name

      • elementIndexVariableTipText

        public String elementIndexVariableTipText()
        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
        Overrides:
        accepts in class SubProcess
        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
        Overrides:
        input in class SubProcess
        Parameters:
        token - the token to accept and process

      • doExecuteSequential

        protected String doExecuteSequential()
        Applies the actors to the array elements sequentially.
        Returns:
        null if everything is fine, otherwise error message

      • doExecuteParallel

        protected String doExecuteParallel()
        Applies the actors to the array elements in parallel.
        Returns:
        null if everything is fine, otherwise error message

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Specified by:
        hasPendingOutput in interface OutputProducer
        Overrides:
        hasPendingOutput in class SubProcess
        Returns:
        true if there is pending output

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class Sequence