Package adams.flow.condition.bool

Class TableExists

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.bool.AbstractBooleanCondition

adams.flow.condition.bool.AbstractBooleanDatabaseCondition

adams.flow.condition.bool.TableExists

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<BooleanCondition>, SizeOfHandler, Stoppable, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, BooleanCondition, Serializable

public class TableExists
extends AbstractBooleanDatabaseCondition

Checks whether table(s) exist that match the given regular expression.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression used for matching the table names.
    default: .*
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseRegExp	m_RegExp	the regular expression for the table name to match.

Fields inherited from class adams.flow.condition.bool.AbstractBooleanDatabaseCondition

m_DatabaseConnection, m_DatabaseConnectionUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TableExists()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doEvaluate(Actor owner, Token token)	Performs the actual evaluation.
String	getQuickInfo()	Returns the quick info string to be displayed in the flow editor.
BaseRegExp	getRegExp()	Returns the regular expression to match the table names against.
String	globalInfo()	Returns a string describing the object.
String	regExpTipText()	Returns the tip text for this property.
void	setRegExp(BaseRegExp value)	Sets the regular expression to match the table names against.

Methods inherited from class adams.flow.condition.bool.AbstractBooleanDatabaseCondition

getConnection, getDatabaseConnection, getDefaultDatabaseConnection, initialize, preEvaluate, reset, setDatabaseConnection

Methods inherited from class adams.flow.condition.bool.AbstractBooleanCondition

evaluate, setUp, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_RegExp

protected BaseRegExp m_RegExp

the regular expression for the table name to match.

Constructor Detail

TableExists

public TableExists()

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 AbstractOptionHandler

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.

getQuickInfo

public String getQuickInfo()

Returns the quick info string to be displayed in the flow editor.

Specified by:

getQuickInfo in interface BooleanCondition

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in class AbstractBooleanCondition

Returns:

the info or null if no info to be displayed

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface BooleanCondition

Specified by:

accepts in class AbstractBooleanCondition

Returns:

Unknown

doEvaluate

protected boolean doEvaluate(Actor owner,
                             Token token)

Performs the actual evaluation.

Specified by:

doEvaluate in class AbstractBooleanCondition

Parameters:

owner - the owning actor

token - the current token passing through

Returns:

true if the condition evaluates to 'true'