Package adams.flow.transformer

Class MultiSpectrumAdd

  • 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.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.control.StorageUser, adams.flow.core.Actor, adams.flow.core.CallableActorUser, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, Serializable, Comparable
    public class MultiSpectrumAdd
extends adams.flow.transformer.AbstractTransformer
implements adams.flow.core.CallableActorUser, adams.flow.control.StorageUser
    Adds a value obtained from either the callable actor or from storage.
    Callable actor takes precedent over storage, i.e., only if the callable actor cannot be located, is the storage name used.

    Input/output:
    - accepts:
       knir.data.spectrum.MultiSpectrum
    - generates:
       knir.data.spectrum.MultiSpectrum


    -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: MultiSpectrumAdd
 
    -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
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -callable <adams.flow.core.CallableActorReference> (property: callableName)
    The name of the callable actor to use.
    default: unknown
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the stored value to retrieve.
    default: storage
    Version:
    $Revision: 1286 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKUP_CALLABLEACTOR
      the key for backing up the callable actor.
      static String BACKUP_CONFIGURED
      the key for backing up the configured state.
      protected adams.flow.core.Actor m_CallableActor
      the callable actor.
      protected adams.flow.core.CallableActorReference m_CallableName
      the callable name.
      protected boolean m_Configured
      whether the callable actor has been configured.
      protected adams.flow.core.CallableActorHelper m_Helper
      the helper class.
      protected adams.flow.control.StorageName m_StorageName
      the name of the stored value.

      • Fields inherited from class adams.flow.transformer.AbstractTransformer

        BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      String callableNameTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      protected adams.flow.core.Actor findCallableActor()
      Tries to find the callable actor referenced by its callable name.
      Class[] generates()
      Returns the class of objects that it generates.
      adams.flow.core.Actor getCallableActor()
      Returns the currently set callable actor.
      adams.flow.core.CallableActorReference getCallableName()
      Returns the name of the callable actor in use.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      adams.flow.control.StorageName getStorageName()
      Returns the name of the stored value.
      String globalInfo()
      Returns a string describing the object.
      boolean hasCallableActor()
      Checks whether a reference to the callable actor is currently available.
      protected void initialize()
      Initializes the members.
      boolean isUsingStorage()
      Returns whether storage items are being used.
      protected void pruneBackup()
      Removes entries from the backup.
      protected void reset()
      Resets the scheme.
      protected void restoreState​(Hashtable<String,​Object> state)
      Restores the state of the actor before the variables got updated.
      void setCallableName​(adams.flow.core.CallableActorReference value)
      Sets the name of the callable actor to use.
      void setStorageName​(adams.flow.control.StorageName value)
      Sets the name of the stored value.
      String setUp()
      Initializes the item for flow execution.
      protected String setUpCallableActor()
      Configures the callable actor.
      String storageNameTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, wrapUp

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

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, 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, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

      • 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.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • BACKUP_CALLABLEACTOR

        public static final String BACKUP_CALLABLEACTOR
        the key for backing up the callable actor.
        See Also:
        Constant Field Values

      • BACKUP_CONFIGURED

        public static final String BACKUP_CONFIGURED
        the key for backing up the configured state.
        See Also:
        Constant Field Values

      • m_CallableName

        protected adams.flow.core.CallableActorReference m_CallableName
        the callable name.

      • m_CallableActor

        protected adams.flow.core.Actor m_CallableActor
        the callable actor.

      • m_Configured

        protected boolean m_Configured
        whether the callable actor has been configured.

      • m_Helper

        protected adams.flow.core.CallableActorHelper m_Helper
        the helper class.

      • m_StorageName

        protected adams.flow.control.StorageName m_StorageName
        the name of the stored value.

    • Constructor Detail

      • MultiSpectrumAdd

        public MultiSpectrumAdd()

    • 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

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.flow.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.core.AbstractActor

      • setCallableName

        public void setCallableName​(adams.flow.core.CallableActorReference value)
        Sets the name of the callable actor to use.
        Parameters:
        value - the callable name

      • getCallableName

        public adams.flow.core.CallableActorReference getCallableName()
        Returns the name of the callable actor in use.
        Returns:
        the callable name

      • callableNameTipText

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

      • setStorageName

        public void setStorageName​(adams.flow.control.StorageName value)
        Sets the name of the stored value.
        Parameters:
        value - the name

      • getStorageName

        public adams.flow.control.StorageName getStorageName()
        Returns the name of the stored value.
        Returns:
        the name

      • storageNameTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • findCallableActor

        protected adams.flow.core.Actor findCallableActor()
        Tries to find the callable actor referenced by its callable name.
        Returns:
        the callable actor or null if not found

      • hasCallableActor

        public boolean hasCallableActor()
        Checks whether a reference to the callable actor is currently available.
        Returns:
        true if a reference is available
        See Also:
        getCallableActor()

      • getCallableActor

        public adams.flow.core.Actor getCallableActor()
        Returns the currently set callable actor.
        Specified by:
        getCallableActor in interface adams.flow.core.CallableActorUser
        Returns:
        the actor, can be null

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface adams.flow.control.StorageUser
        Returns:
        true if storage items are used

      • pruneBackup

        protected void pruneBackup()
        Removes entries from the backup.
        Overrides:
        pruneBackup in class adams.flow.core.AbstractActor

      • backupState

        protected Hashtable<String,​Object> backupState()
        Backs up the current state of the actor before update the variables.
        Overrides:
        backupState in class adams.flow.transformer.AbstractTransformer
        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 adams.flow.transformer.AbstractTransformer
        Parameters:
        state - the backup of the state to restore from

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Returns:
        the default DataContainer class for the project

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface adams.flow.core.OutputProducer
        Returns:
        the default DataContainer class for the project

      • setUpCallableActor

        protected String setUpCallableActor()
        Configures the callable actor.
        Returns:
        null if successful, otherwise error message

      • setUp

        public String setUp()
        Initializes the item for flow execution.
        Specified by:
        setUp in interface adams.flow.core.Actor
        Overrides:
        setUp in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • doExecute

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