Package adams.flow.source

Class AbstractListTables

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.source.AbstractSource

adams.flow.source.AbstractArrayProvider

adams.flow.source.AbstractDbArrayProvider

adams.flow.source.AbstractListTables

All Implemented Interfaces:

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

Direct Known Subclasses:

ListTables

public abstract class AbstractListTables
extends AbstractDbArrayProvider

Ancestor for sources that list tables from a database.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Invert	whether to invert the matching sense.
protected BaseRegExp	m_RegExp	the regular expression to match.

Fields inherited from class adams.flow.source.AbstractDbArrayProvider

m_DatabaseConnection

Fields inherited from class adams.flow.source.AbstractArrayProvider

m_Index, m_OutputArray, m_Queue

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getInvert()	Returns whether to invert the matching sense.
protected Class	getItemClass()	Returns the based class of the items.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
BaseRegExp	getRegExp()	Returns the regular expression to match the table names against.
String	globalInfo()	Returns a string describing the object.
String	invertTipText()	Returns the tip text for this property.
String	outputArrayTipText()	Returns the tip text for this property.
protected String	queryDatabase()	Performs the actual database query.
String	regExpTipText()	Returns the tip text for this property.
void	setInvert(boolean value)	Sets whether to invert the matching sense.
void	setRegExp(BaseRegExp value)	Sets the regular expression to match the table names against.

Methods inherited from class adams.flow.source.AbstractDbArrayProvider

doExecute, getDatabaseConnection, getDefaultDatabaseConnection, initialize, setUpDatabaseConnection, wrapUp

Methods inherited from class adams.flow.source.AbstractArrayProvider

generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, 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, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, restoreState, 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 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, 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_RegExp

protected BaseRegExp m_RegExp

the regular expression to match.

m_Invert

protected boolean m_Invert

whether to invert the matching sense.

Constructor Detail

AbstractListTables

public AbstractListTables()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractArrayProvider

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

getItemClass

protected Class getItemClass()

Returns the based class of the items.

Specified by:

getItemClass in class AbstractArrayProvider

Returns:

the class

outputArrayTipText

public String outputArrayTipText()

Returns the tip text for this property.

Specified by:

outputArrayTipText in interface ArrayProvider

Specified by:

outputArrayTipText in interface ArrayProvider

Specified by:

outputArrayTipText in class AbstractArrayProvider

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression to match the table names against.

Parameters:

value - the regular expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression to match the table names against.

Returns:

the regular expression

regExpTipText

public String regExpTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setInvert

public void setInvert(boolean value)

Sets whether to invert the matching sense.

Parameters:

value - true if inverting matching sense

getInvert

public boolean getInvert()

Returns whether to invert the matching sense.

Returns:

true if matching sense is inverted

invertTipText

public String invertTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

queryDatabase

protected String queryDatabase()

Performs the actual database query.

Specified by:

queryDatabase in class AbstractDbArrayProvider

Returns:

null if everything is fine, otherwise error message