Package adams.flow.source

Class SpectrumSupplier

  • 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.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.OutputProducer, Serializable, Comparable
    public class SpectrumSupplier
extends adams.flow.source.AbstractDbSource
    Loads spectra from the database that matched the specified conditions.

    Input/output:
    - generates:
       adams.data.spectrum.Spectrum


    -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: SpectrumSupplier
 
    -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
 
    -conditions <adams.db.AbstractSpectrumConditions> (property: conditions)
    The conditions for retrieving the spectra from the database.
    default: adams.db.SpectrumConditionsMulti
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected AbstractSpectrumConditions m_Conditions
      the conditions to use.
      protected SpectrumIterator m_Iterator
      the iterator.
      protected boolean m_NewConnection
      whether to use a new database connection.
      protected adams.core.VariableName m_NumRowsVar
      the variable to store the number of rows in.
      protected boolean m_UpdateNumRowsVar
      whether to update the variable with the number of rows.

      • Fields inherited from class adams.flow.source.AbstractDbSource

        m_DatabaseConnection

      • 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
      protected void closeIterator()
      Closes the iterator, if necessary.
      String conditionsTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      Class[] generates()
      Returns the class of objects that it generates.
      AbstractSpectrumConditions getConditions()
      Returns the conditions container to use for retrieving the spectra.
      protected adams.db.AbstractDatabaseConnection getDatabaseConnection()
      Determines the database connection in the flow.
      protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
      Returns the default database connection.
      boolean getNewConnection()
      Returns whether to use a new connection for this update.
      adams.core.VariableName getNumRowsVar()
      Returns the variable to store the number of rows in.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getUpdateNumRowsVar()
      Returns whether to update the variable with the number of rows.
      String globalInfo()
      Returns a string describing the object.
      boolean hasPendingOutput()
      Checks whether there is pending output to be collected after executing the flow item.
      String newConnectionTipText()
      Returns the tip text for this property.
      String numRowsVarTipText()
      Returns the tip text for this property.
      adams.flow.core.Token output()
      Returns the generated token.
      protected String queryDatabase()
      Performs the actual database query.
      protected void reset()
      Resets the scheme.
      void setConditions​(AbstractSpectrumConditions value)
      Sets the conditions container to use for retrieving the spectra.
      void setNewConnection​(boolean value)
      Sets whether to use a new connection for this update.
      void setNumRowsVar​(adams.core.VariableName value)
      Sets the variable to store the number of rows in.
      void setUpdateNumRowsVar​(boolean value)
      Sets whether to update the variable with the number of rows.
      String updateNumRowsVarTipText()
      Returns the tip text for this property.
      void wrapUp()
      Cleans up after the execution has finished.

      • Methods inherited from class adams.flow.source.AbstractDbSource

        doExecute, initialize, setUpDatabaseConnection

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

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, 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, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, 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, toCommandLine, toString

      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel

      • 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, 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

      • 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

      • m_UpdateNumRowsVar

        protected boolean m_UpdateNumRowsVar
        whether to update the variable with the number of rows.

      • m_NumRowsVar

        protected adams.core.VariableName m_NumRowsVar
        the variable to store the number of rows in.

      • m_NewConnection

        protected boolean m_NewConnection
        whether to use a new database connection.

    • Constructor Detail

      • SpectrumSupplier

        public SpectrumSupplier()

    • 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

      • setConditions

        public void setConditions​(AbstractSpectrumConditions value)
        Sets the conditions container to use for retrieving the spectra.
        Parameters:
        value - the conditions

      • getConditions

        public AbstractSpectrumConditions getConditions()
        Returns the conditions container to use for retrieving the spectra.
        Returns:
        the conditions

      • conditionsTipText

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

      • setUpdateNumRowsVar

        public void setUpdateNumRowsVar​(boolean value)
        Sets whether to update the variable with the number of rows.
        Parameters:
        value - true if to update

      • getUpdateNumRowsVar

        public boolean getUpdateNumRowsVar()
        Returns whether to update the variable with the number of rows.
        Returns:
        true if to update

      • updateNumRowsVarTipText

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

      • setNumRowsVar

        public void setNumRowsVar​(adams.core.VariableName value)
        Sets the variable to store the number of rows in.
        Parameters:
        value - the name

      • getNumRowsVar

        public adams.core.VariableName getNumRowsVar()
        Returns the variable to store the number of rows in.
        Returns:
        the name

      • numRowsVarTipText

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

      • setNewConnection

        public void setNewConnection​(boolean value)
        Sets whether to use a new connection for this update. Use when autoCommit is off.
        Parameters:
        value - true if to use new connection

      • getNewConnection

        public boolean getNewConnection()
        Returns whether to use a new connection for this update. Use when autoCommit is off.
        Returns:
        true if to use new connection

      • newConnectionTipText

        public String newConnectionTipText()
        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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • getDefaultDatabaseConnection

        protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
        Returns the default database connection.
        Specified by:
        getDefaultDatabaseConnection in class adams.flow.source.AbstractDbSource
        Returns:
        the default database connection

      • getDatabaseConnection

        protected adams.db.AbstractDatabaseConnection getDatabaseConnection()
        Determines the database connection in the flow.
        Specified by:
        getDatabaseConnection in class adams.flow.source.AbstractDbSource
        Returns:
        the database connection to use

      • queryDatabase

        protected String queryDatabase()
        Performs the actual database query.
        Specified by:
        queryDatabase in class adams.flow.source.AbstractDbSource
        Returns:
        null if everything is fine, otherwise error message

      • output

        public adams.flow.core.Token output()
        Returns the generated token.
        Returns:
        the generated token

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.

        The method is not allowed allowed to return "true" before the actor has been executed. For actors that return an infinite number of tokens, the m_Executed flag can be returned.
        Returns:
        true if there is pending output

      • closeIterator

        protected void closeIterator()
        Closes the iterator, if necessary.

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished. Graphical output is left untouched.
        Specified by:
        wrapUp in interface adams.flow.core.Actor
        Overrides:
        wrapUp in class adams.flow.source.AbstractDbSource