Package adams.db

Class AbstractTimeWindowTableCleanUp

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.db.AbstractTableCleanUp

adams.db.AbstractTimeWindowTableCleanUp

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, Serializable

public abstract class AbstractTimeWindowTableCleanUp
extends AbstractTableCleanUp

Ancestor for clean up schemes that use a time window.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseDateTime	m_EndDate	the end date.
protected BaseDateTime	m_StartDate	the start date.

Fields inherited from class adams.db.AbstractTableCleanUp

m_Connection

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

Method Summary

Modifier and Type	Method	Description
protected String	check()	Performs checks before cleaning up the table.
void	defineOptions()	Adds options to the internal list of options.
String	endDateTipText()	Returns the tip text for this property.
BaseDateTime	getEndDate()	Returns the end date.
BaseDateTime	getStartDate()	Returns the start date.
void	setEndDate(BaseDateTime value)	Sets the end date.
void	setStartDate(BaseDateTime value)	Sets the start date.
String	startDateTipText()	Returns the tip text for this property.

Methods inherited from class adams.db.AbstractTableCleanUp

cleanUpTable, doCleanUpTable, getDatabaseConnection, setDatabaseConnection

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, 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_StartDate

protected BaseDateTime m_StartDate

the start date.

m_EndDate

protected BaseDateTime m_EndDate

the end date.

Constructor Detail

AbstractTimeWindowTableCleanUp

public AbstractTimeWindowTableCleanUp()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setStartDate

public void setStartDate(BaseDateTime value)

Sets the start date.

Parameters:

value - the start date

getStartDate

public BaseDateTime getStartDate()

Returns the start date.

Returns:

the start date

startDateTipText

public String startDateTipText()

Returns the tip text for this property.

Returns:

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

setEndDate

public void setEndDate(BaseDateTime value)

Sets the end date.

Parameters:

value - the end date

getEndDate

public BaseDateTime getEndDate()

Returns the end date.

Returns:

the end date

endDateTipText

public String endDateTipText()

Returns the tip text for this property.

Returns:

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

check

protected String check()

Performs checks before cleaning up the table.

Overrides:

check in class AbstractTableCleanUp

Returns:

null if checks successful, otherwise error message