Package adams.flow.standalone

Class Rats

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.Pausable, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ActorHandler, adams.flow.core.ActorReferenceHandler, adams.flow.core.ErrorHandler, adams.flow.core.Flushable, adams.flow.core.MutableActorHandler, adams.flow.standalone.StandaloneGroup<Rat>, adams.flow.standalone.StandaloneMutableGroup<Rat>, Serializable, Comparable
    public class Rats
extends adams.flow.standalone.AbstractStandaloneMutableGroup<Rat>
implements adams.core.Pausable, adams.flow.core.ActorReferenceHandler
    Encapsulates all Rat setups. 

    -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: Rats
 
    -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
 
    -rat <adams.flow.core.Actor> [-rat ...] (property: rats)
    The reception/transmission setups.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_Paused
      whether the execution has been paused.

      • Fields inherited from class adams.flow.standalone.AbstractStandaloneGroup

        m_Actors

      • 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
      Rats()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String check()
      Performs checks on the "sub-actors".
      protected String checkActor​(adams.flow.core.Actor actor)
      Checks whether the actor is valid.
      protected String checkActor​(adams.flow.core.Actor actor, int index)
      Checks the actor whether it is of the correct type.
      String checkActorReferenceHandlers()
      Ensures that the handlers appear in the correct order.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      adams.flow.core.ActorHandlerInfo getActorHandlerInfo()
      Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
      protected List<Rat> getDefaultActors()
      Returns the list of default actors.
      Class[] getProhibitedPrecedingActorReferenceHandlers()
      Returns the classes that are prohibited to appear before this reference handler.
      adams.flow.core.Actor[] getRats()
      Returns the receptions to use.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      boolean isPaused()
      Returns whether the object is currently paused.
      boolean isReferencingRequired()
      Returns whether actors have to be referenced elsewhere in the flow or whether it is optional.
      void pauseExecution()
      Pauses the execution.
      String ratsTipText()
      Returns the tip text for this property.
      void resumeExecution()
      Resumes the execution.
      void setRats​(adams.flow.core.Actor[] value)
      Sets the receptions to use.

      • Methods inherited from class adams.flow.standalone.AbstractStandaloneMutableGroup

        add, add, remove, removeAll

      • Methods inherited from class adams.flow.standalone.AbstractStandaloneGroup

        checkActors, cleanUp, find, firstActive, flushExecution, forceVariables, get, getActorFilter, getActors, getActors, getActorsBelow, hasActor, hasActorBelow, indexOf, lastActive, set, setActors, setParent, setUp, size, stopExecution, updateParent, wrapUp

      • Methods inherited from class adams.flow.standalone.AbstractStandalone

        preExecute

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, 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, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

      • 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 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.flow.core.ActorHandler

        firstActive, flushExecution, get, indexOf, lastActive, set, size

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • 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.flow.core.MutableActorHandler

        add, add, remove, removeAll

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Paused

        protected boolean m_Paused
        whether the execution has been paused.

    • Constructor Detail

      • Rats

        public Rats()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.flow.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.standalone.AbstractStandaloneGroup<Rat>

      • getDefaultActors

        protected List<Rat> getDefaultActors()
        Returns the list of default actors.
        Specified by:
        getDefaultActors in class adams.flow.standalone.AbstractStandaloneGroup<Rat>
        Returns:
        the default actors

      • setRats

        public void setRats​(adams.flow.core.Actor[] value)
        Sets the receptions to use.
        Parameters:
        value - the receptions

      • getRats

        public adams.flow.core.Actor[] getRats()
        Returns the receptions to use.
        Returns:
        the receptions

      • ratsTipText

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

      • getActorHandlerInfo

        public adams.flow.core.ActorHandlerInfo getActorHandlerInfo()
        Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
        Specified by:
        getActorHandlerInfo in interface adams.flow.core.ActorHandler
        Overrides:
        getActorHandlerInfo in class adams.flow.standalone.AbstractStandaloneGroup<Rat>
        Returns:
        the info

      • getProhibitedPrecedingActorReferenceHandlers

        public Class[] getProhibitedPrecedingActorReferenceHandlers()
        Returns the classes that are prohibited to appear before this reference handler.
        Specified by:
        getProhibitedPrecedingActorReferenceHandlers in interface adams.flow.core.ActorReferenceHandler
        Returns:
        the classes

      • checkActorReferenceHandlers

        public String checkActorReferenceHandlers()
        Ensures that the handlers appear in the correct order.
        Specified by:
        checkActorReferenceHandlers in interface adams.flow.core.ActorReferenceHandler
        Returns:
        null if OK, otherwise error message
        See Also:
        getProhibitedPrecedingActorReferenceHandlers()

      • isReferencingRequired

        public boolean isReferencingRequired()
        Returns whether actors have to be referenced elsewhere in the flow or whether it is optional.
        Specified by:
        isReferencingRequired in interface adams.flow.core.ActorReferenceHandler
        Returns:
        true if required, false if optional

      • checkActor

        protected String checkActor​(adams.flow.core.Actor actor,
                            int index)
        Checks the actor whether it is of the correct type.
        Overrides:
        checkActor in class adams.flow.standalone.AbstractStandaloneGroup<Rat>
        Parameters:
        actor - the actor to check
        index - the index of actor, ignored if -1
        Returns:
        null if OK, otherwise the error message

      • checkActor

        protected String checkActor​(adams.flow.core.Actor actor)
        Checks whether the actor is valid.
        Overrides:
        checkActor in class adams.flow.standalone.AbstractStandaloneGroup<Rat>
        Parameters:
        actor - the actor to check
        Returns:
        null if OK, otherwise error message

      • check

        public String check()
        Performs checks on the "sub-actors".
        Specified by:
        check in interface adams.flow.core.ActorHandler
        Specified by:
        check in class adams.flow.standalone.AbstractStandaloneGroup<Rat>
        Returns:
        null if everything is fine, otherwise the error

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.standalone.AbstractStandaloneGroup<Rat>
        Returns:
        null if everything is fine, otherwise error message

      • pauseExecution

        public void pauseExecution()
        Pauses the execution.
        Specified by:
        pauseExecution in interface adams.core.Pausable

      • isPaused

        public boolean isPaused()
        Returns whether the object is currently paused.
        Specified by:
        isPaused in interface adams.core.Pausable
        Returns:
        true if object is paused

      • resumeExecution

        public void resumeExecution()
        Resumes the execution.
        Specified by:
        resumeExecution in interface adams.core.Pausable