Package adams.flow.transformer

Class SampleDataValueDbWriter

  • 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, Serializable, Comparable
    public class SampleDataValueDbWriter
extends adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
    Stores the specified values from the sample data passing through in the database.

    Input/output:
    - accepts:
       adams.data.report.Report
       adams.data.sampledata.SampleData
       adams.data.report.ReportHandler
    - generates:
       adams.data.report.Report
       adams.data.sampledata.SampleData
       adams.data.report.ReportHandler


    -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: SampleDataValueDbWriter
 
    -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
 
    -field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to store in the sampledata table.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

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

        m_Fields

      • 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.
      protected adams.data.report.Field[] assembleFields()
      Method for assembling the fields to overwrite.
      protected String extractID​(SampleData report)
      Extracts the ID from the report.
      protected SampleData extractSubset​(SampleData report)
      Generates a subset of the report, which only contains the specified fields.
      String fieldsTipText()
      Returns the tip text for this property.
      Class[] generates()
      Returns the class of objects that it generates.
      protected adams.db.AbstractDatabaseConnection getDatabaseConnection()
      Determines the database connection in the flow.
      protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
      Returns the default database connection.
      protected adams.data.report.AbstractField[] getDefaultFields()
      Returns the default fields for the option.
      adams.data.report.Field[] getFields()
      Returns the fields to store in the database.
      protected adams.db.ReportProviderByID<SampleData> getReportProvider()
      Returns the report provider to use for removing the
      String globalInfo()
      Returns a string describing the object.
      void setFields​(adams.data.report.Field[] value)
      Sets the fields to store in the database.

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

        defineOptions, getQuickInfo, queryDatabase

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

    • Constructor Detail

      • SampleDataValueDbWriter

        public SampleDataValueDbWriter()

    • 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

      • getDefaultFields

        protected adams.data.report.AbstractField[] getDefaultFields()
        Returns the default fields for the option.
        Specified by:
        getDefaultFields in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        Returns:
        the default fields

      • setFields

        public void setFields​(adams.data.report.Field[] value)
        Sets the fields to store in the database.
        Parameters:
        value - the fields

      • getFields

        public adams.data.report.Field[] getFields()
        Returns the fields to store in the database.
        Returns:
        the fields

      • fieldsTipText

        public String fieldsTipText()
        Returns the tip text for this property.
        Specified by:
        fieldsTipText in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        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 adams.flow.core.InputConsumer
        Specified by:
        accepts in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        Returns:
        the report class

      • 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.AbstractReportValueDbWriter<SampleData>
        Returns:
        the report class

      • getReportProvider

        protected adams.db.ReportProviderByID<SampleData> getReportProvider()
        Returns the report provider to use for removing the
        Specified by:
        getReportProvider in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        Returns:
        the provider

      • getDefaultDatabaseConnection

        protected adams.db.AbstractDatabaseConnection getDefaultDatabaseConnection()
        Returns the default database connection.
        Specified by:
        getDefaultDatabaseConnection in class adams.flow.transformer.AbstractDbTransformer
        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.transformer.AbstractDbTransformer
        Returns:
        the database connection to use

      • extractID

        protected String extractID​(SampleData report)
        Extracts the ID from the report.
        Specified by:
        extractID in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        Parameters:
        report - the report to extract the ID from
        Returns:
        the ID

      • assembleFields

        protected adams.data.report.Field[] assembleFields()
        Method for assembling the fields to overwrite.
        Overrides:
        assembleFields in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        Returns:
        the fields

      • extractSubset

        protected SampleData extractSubset​(SampleData report)
        Generates a subset of the report, which only contains the specified fields.
        Specified by:
        extractSubset in class adams.flow.transformer.AbstractReportValueDbWriter<SampleData>
        Parameters:
        report - the report to process
        Returns:
        the subset report