Package adams.flow.transformer

Class SampleDataDbReader

  • 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, SampleDataDatabaseReader, Serializable, Comparable
    public class SampleDataDbReader
extends adams.flow.transformer.AbstractReportDbReader<SampleData,​String>
implements SampleDataDatabaseReader
    Loads sample data from the database and passes it on.

    Input/output:
    - accepts:
       java.lang.Integer
    - generates:
       knir.data.sampledata.SampleData


    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -name <java.lang.String> (property: name)
         The name of the actor.
         default: SampleDataDbReader
 
    -annotation <adams.core.base.BaseText> (property: annotations)
         The annotations to attach to this actor.
         default:
 
    -skip (property: skip)
         If set to true, transformation is skipped and the input token is just forwarded
          as it is.
 
    -store (property: useStoreTable)
         If set to true, then the data will get read from the store table, otherwise
          the active one.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

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

        m_PostProcessor

      • 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.
      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.db.ReportProviderByID<SampleData> getReportProvider()
      Returns the report provider to use.
      String globalInfo()
      Returns a string describing the object.

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

        defineOptions, getPostProcessor, getQuickInfo, postProcessorTipText, queryDatabase, setPostProcessor

      • 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, 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.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, defineOptions, getOptionManager

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

        hasPendingOutput, output

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Constructor Detail

      • SampleDataDbReader

        public SampleDataDbReader()

    • 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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Overrides:
        accepts in class adams.flow.transformer.AbstractReportDbReader<SampleData,​String>
        Returns:
        java.lang.Integer.class, java.lang.String.class

      • 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

      • getReportProvider

        protected adams.db.ReportProviderByID<SampleData> getReportProvider()
        Returns the report provider to use.
        Specified by:
        getReportProvider in class adams.flow.transformer.AbstractReportDbReader<SampleData,​String>
        Returns:
        the report provider

      • 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.AbstractReportDbReader<SampleData,​String>
        Returns:
        the type of report