Package adams.flow.standalone

Class AbstractCallableDatabaseConnection

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.core.AbstractCallableActor

adams.flow.standalone.AbstractCallableDatabaseConnection

All Implemented Interfaces:

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

Direct Known Subclasses:

CallableDatabaseConnection

public abstract class AbstractCallableDatabaseConnection
extends AbstractCallableActor
implements AbstractDatabaseConnectionProvider

Ancestor for callable database connection standalones.

Version:

$Revision: 12532 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.core.AbstractCallableActor

BACKUP_CALLABLEACTOR, BACKUP_CONFIGURED, m_CallableActor, m_CallableName, m_Configured, m_FindCallableActorError, m_Helper, m_Optional

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
AbstractCallableDatabaseConnection()

Method Summary

Modifier and Type	Method	Description
protected String	executeCallableActor()	Executes the callable actor.
protected Actor	findCallableActor()	Tries to find the callable actor referenced by its name.
AbstractDatabaseConnection	getConnection()	Returns the database connection in use.
protected abstract Class	getRequiredDatabaseConnectionProvider()	Returns the required database connection provider class.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.core.AbstractCallableActor

backupState, callableNameTipText, cleanUp, defineOptions, doExecute, getCallableActor, getCallableName, getOptional, getQuickInfo, hasCallableActor, initialize, isFinished, optionalTipText, pruneBackup, reset, restoreState, setCallableName, setOptional, setUp, setUpCallableActor, stopExecution

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, 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, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

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 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, 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.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.core.VariablesInspectionHandler

canInspectOptions

Constructor Detail

AbstractCallableDatabaseConnection

public AbstractCallableDatabaseConnection()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getRequiredDatabaseConnectionProvider

protected abstract Class getRequiredDatabaseConnectionProvider()

Returns the required database connection provider class.

Returns:

the class

findCallableActor

protected Actor findCallableActor()

Tries to find the callable actor referenced by its name. Makes sure that the actor produces output.

Overrides:

findCallableActor in class AbstractCallableActor

Returns:

the callable actor or null if not found

executeCallableActor

protected String executeCallableActor()

Executes the callable actor.

Specified by:

executeCallableActor in class AbstractCallableActor

Returns:

null if no error, otherwise error message

getConnection

public AbstractDatabaseConnection getConnection()

Returns the database connection in use. Reconnects the database, to make sure that the database connection is the correct one.

Specified by:

getConnection in interface AbstractDatabaseConnectionProvider

Returns:

the connection object