Package adams.flow.transformer

Class AbstractReportValueDbWriter<T extends Report>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.AbstractDbTransformer

adams.flow.transformer.AbstractReportValueDbWriter<T>

Type Parameters:

T - the type of report to handle

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DatabaseConnectionUser, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public abstract class AbstractReportValueDbWriter<T extends Report>
extends AbstractDbTransformer

Abstract ancestor for actors that write report values to the database.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Field[]	m_Fields	the fields to write to DB.

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

Constructor Summary

Constructors

Constructor	Description
AbstractReportValueDbWriter()

Method Summary

Modifier and Type	Method	Description
abstract Class[]	accepts()	Returns the class that the consumer accepts.
protected Field[]	assembleFields()	Method for assembling the fields to overwrite.
void	defineOptions()	Adds options to the internal list of options.
protected abstract String	extractID(T report)	Extracts the ID from the report.
protected abstract T	extractSubset(T report)	Generates a subset of the report, which only contains the specified fields.
abstract String	fieldsTipText()	Returns the tip text for this property.
abstract Class[]	generates()	Returns the class of objects that it generates.
protected abstract AbstractField[]	getDefaultFields()
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
protected abstract ReportProviderByID<T>	getReportProvider()	Returns the report provider to use for writing the report values to the database.
protected String	queryDatabase()	Executes the flow item.

Methods inherited from class adams.flow.transformer.AbstractDbTransformer

doExecute, getDatabaseConnection, getDefaultDatabaseConnection, 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, globalInfo, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Field Detail

m_Fields

protected Field[] m_Fields

the fields to write to DB.

Constructor Detail

AbstractReportValueDbWriter

public AbstractReportValueDbWriter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

getDefaultFields

protected abstract AbstractField[] getDefaultFields()

fieldsTipText

public abstract String fieldsTipText()

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 Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

accepts

public abstract Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the report class

generates

public abstract Class[] generates()

Returns the class of objects that it generates.

Returns:

the report class

getReportProvider

protected abstract ReportProviderByID<T> getReportProvider()

Returns the report provider to use for writing the report values to the database.

Returns:

the provider to use

extractID

protected abstract String extractID(T report)

Extracts the ID from the report.

Parameters:

report - the report to extract the ID from

Returns:

the ID

assembleFields

protected Field[] assembleFields()

Method for assembling the fields to overwrite.
Default implementation just returns the supplied fields

Returns:

the fields

extractSubset

protected abstract T extractSubset(T report)

Generates a subset of the report, which only contains the specified fields.

Parameters:

report - the report to process

Returns:

the subset report

queryDatabase

protected String queryDatabase()

Executes the flow item.

Specified by:

queryDatabase in class AbstractDbTransformer

Returns:

null if everything is fine, otherwise error message