Package adams.flow.standalone

Class TableCleanUp

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.standalone.AbstractStandalone

adams.flow.standalone.AbstractDbStandalone

adams.flow.standalone.TableCleanUp

All Implemented Interfaces:

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

public class TableCleanUp
extends AbstractDbStandalone

Runs a table cleaner.

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
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: TableCleanUp
 

-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.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-cleaner <adams.db.AbstractTableCleanUp> (property: cleaner)
    The table cleaner to run.
    default: adams.db.SQLTableCleanUp
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractTableCleanUp	m_Cleaner	the cleaner to run.

Fields inherited from class adams.flow.standalone.AbstractDbStandalone

m_DatabaseConnection

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

Method Summary

Modifier and Type	Method	Description
String	cleanerTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
AbstractTableCleanUp	getCleaner()	Returns the cleaner in use.
protected AbstractDatabaseConnection	getDatabaseConnection()	Determines the database connection in the flow.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection()	Returns the default database connection.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
protected String	queryDatabase()	Performs the actual database query.
void	setCleaner(AbstractTableCleanUp value)	Sets the cleaner to use.

Methods inherited from class adams.flow.standalone.AbstractDbStandalone

doExecute, initialize, setUpDatabaseConnection, wrapUp

Methods inherited from class adams.flow.standalone.AbstractStandalone

preExecute

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, reset, 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

toCommandLine

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

Field Detail

m_Cleaner

protected AbstractTableCleanUp m_Cleaner

the cleaner to run.

Constructor Detail

TableCleanUp

public TableCleanUp()

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 AbstractActor

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

setCleaner

public void setCleaner(AbstractTableCleanUp value)

Sets the cleaner to use.

Parameters:

value - the cleaner

getCleaner

public AbstractTableCleanUp getCleaner()

Returns the cleaner in use.

Returns:

the cleaner

cleanerTipText

public String cleanerTipText()

Returns the tip text for this property.

Returns:

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

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class AbstractDbStandalone

Returns:

the default database connection

getDatabaseConnection

protected AbstractDatabaseConnection getDatabaseConnection()

Determines the database connection in the flow.

Specified by:

getDatabaseConnection in class AbstractDbStandalone

Returns:

the database connection to use

queryDatabase

protected String queryDatabase()

Performs the actual database query.

Specified by:

queryDatabase in class AbstractDbStandalone

Returns:

null if everything is fine, otherwise error message