Package adams.flow.transformer

Class SpectrumDbWriter

  • 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.db.DatabaseConnectionUser, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, adams.flow.transformer.DataContainerDbWriter<Spectrum>, SpectrumDatabaseWriter, Serializable, Comparable
    public class SpectrumDbWriter
extends adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
implements SpectrumDatabaseWriter
    Writes a spectrum to the database and passes its ID on.

    Input/output:
    - accepts:
       adams.data.spectrum.Spectrum
    - generates:
       java.lang.Integer


    -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: SpectrumDbWriter
 
    -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
 
    -pre-processor <adams.flow.transformer.datacontainer.AbstractDataContainerPreProcessor> (property: preProcessor)
    The pre-processor to apply to the data.
    default: adams.flow.transformer.datacontainer.NoPreProcessing
 
    -overwrite-existing <boolean> (property: overwriteExisting)
    If enabled, an existing spectrum gets removed from the database first before
    the new one is being written; if disabled, then new spectra that already
    exist in the database won't get added, forwarding -1.
    default: false
 
    -keep-report <boolean> (property: keepReport)
    If enabled, any existing report is kept in the database.
    default: false
 
    -output-container <boolean> (property: outputContainer)
    If enabled, the spectrum (with updated database ID if not -1) is output
    instead of the database ID.
    default: false
 
    -store-wave-no <boolean> (property: storeWaveNo)
    If enabled, the wave numbers get stored in the database as well.
    default: true
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_StoreWaveNo
      whether to store the wave numbers as well.

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

        m_KeepReport, m_OutputContainer, m_OverwriteExisting, m_PreProcessor

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

        m_DatabaseConnection

      • 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.
      Integer add​(adams.db.DataProvider provider, Spectrum cont)
      Adds the container to the database.
      void defineOptions()
      Adds options to the internal list of options.
      boolean exists​(adams.db.DataProvider provider, Spectrum cont)
      Returns whether the container already exists in the database.
      Class[] generates()
      Returns the class of objects that it generates.
      protected adams.db.AbstractDatabaseConnection getDatabaseConnection()
      Determines the database connection in the flow.
      adams.db.DataProvider<Spectrum> getDataProvider​(Spectrum cont)
      Returns the data provider to use for storing the container in the database.
      protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
      Returns the default database connection.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getStoreWaveNo()
      Returns whether to store the wave numbers as well.
      String globalInfo()
      Returns a string describing the object.
      Spectrum load​(adams.db.DataProvider provider, Spectrum cont)
      Loads the container from the database.
      String outputContainerTipText()
      Returns the tip text for this property.
      String overwriteExistingTipText()
      Returns the tip text for this property.
      boolean remove​(adams.db.DataProvider provider, Spectrum cont)
      Removes the container from the database.
      void setStoreWaveNo​(boolean value)
      Sets whether to store the wave numbers as well.
      String storeWaveNoTipText()
      Returns the tip text for this property.

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

        cleanUp, getKeepReport, getOutputContainer, getOverwriteExisting, getPreProcessor, keepReportTipText, preProcess, preProcessorTipText, queryDatabase, setKeepReport, setOutputContainer, setOverwriteExisting, setPreProcessor, store

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

        doExecute, initialize, setUpDatabaseConnection, wrapUp

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

        backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState

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

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, 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, pruneBackup, reset, 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, 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, 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.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.flow.core.InputConsumer

        currentInput, hasInput, input

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

        hasPendingOutput, output

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_StoreWaveNo

        protected boolean m_StoreWaveNo
        whether to store the wave numbers as well.

    • Constructor Detail

      • SpectrumDbWriter

        public SpectrumDbWriter()

    • 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

      • overwriteExistingTipText

        public String overwriteExistingTipText()
        Returns the tip text for this property.
        Specified by:
        overwriteExistingTipText in interface SpectrumDatabaseWriter
        Specified by:
        overwriteExistingTipText in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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.transformer.AbstractDataContainerDbWriter<Spectrum>

      • outputContainerTipText

        public String outputContainerTipText()
        Returns the tip text for this property.
        Specified by:
        outputContainerTipText in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setStoreWaveNo

        public void setStoreWaveNo​(boolean value)
        Sets whether to store the wave numbers as well.
        Parameters:
        value - true if to store

      • getStoreWaveNo

        public boolean getStoreWaveNo()
        Returns whether to store the wave numbers as well.
        Returns:
        true if to store

      • storeWaveNoTipText

        public String storeWaveNoTipText()
        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.transformer.AbstractDataContainerDbWriter<Spectrum>
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Specified by:
        accepts in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Returns:
        the type of data to store

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface adams.flow.core.OutputProducer
        Specified by:
        generates in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Returns:
        the classes

      • getDefaultDatabaseConnection

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

      • getDatabaseConnection

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

      • getDataProvider

        public adams.db.DataProvider<Spectrum> getDataProvider​(Spectrum cont)
        Returns the data provider to use for storing the container in the database.
        Specified by:
        getDataProvider in interface adams.flow.transformer.DataContainerDbWriter<Spectrum>
        Specified by:
        getDataProvider in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Parameters:
        cont - the container
        Returns:
        the data provider

      • add

        public Integer add​(adams.db.DataProvider provider,
                   Spectrum cont)
        Adds the container to the database.
        Specified by:
        add in interface adams.flow.transformer.DataContainerDbWriter<Spectrum>
        Overrides:
        add in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Parameters:
        provider - the provider to use
        cont - the container to store
        Returns:
        the database ID, Constants.NO_ID if failed

      • exists

        public boolean exists​(adams.db.DataProvider provider,
                      Spectrum cont)
        Returns whether the container already exists in the database.
        Specified by:
        exists in interface adams.flow.transformer.DataContainerDbWriter<Spectrum>
        Overrides:
        exists in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Parameters:
        provider - the provider to use for checking
        cont - the container to look for
        Returns:
        true if already stored in database

      • remove

        public boolean remove​(adams.db.DataProvider provider,
                      Spectrum cont)
        Removes the container from the database.
        Specified by:
        remove in interface adams.flow.transformer.DataContainerDbWriter<Spectrum>
        Overrides:
        remove in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Parameters:
        provider - the provider to use for removing
        cont - the container to remove
        Returns:
        true if successfully removed

      • load

        public Spectrum load​(adams.db.DataProvider provider,
                     Spectrum cont)
        Loads the container from the database.
        Specified by:
        load in interface adams.flow.transformer.DataContainerDbWriter<Spectrum>
        Overrides:
        load in class adams.flow.transformer.AbstractDataContainerDbWriter<Spectrum>
        Parameters:
        provider - the provider to use
        cont - the container to store
        Returns:
        the container, null if failed to load