Package adams.tools

Class AbstractTimeWindowDatabaseTool

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.tools.AbstractTool

adams.tools.AbstractDatabaseTool

adams.tools.AbstractTimeWindowDatabaseTool

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, Serializable, Comparable

Direct Known Subclasses:

AbstractAddRemoveTimeWindowDatabaseTool

public abstract class AbstractTimeWindowDatabaseTool
extends AbstractDatabaseTool

Abstract ancestor for database tools that act within a time frame.

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 of the window.
protected BaseDateTime	m_StartDate	the start date of the window.

Fields inherited from class adams.tools.AbstractDatabaseTool

m_dbc

Fields inherited from class adams.tools.AbstractTool

m_Stopped

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

Method Summary

Modifier and Type	Method	Description
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.tools.AbstractDatabaseTool

cleanUp, getDatabaseConnection, getDefaultDatabaseConnection, initialize, setDatabaseConnection

Methods inherited from class adams.tools.AbstractTool

compareTo, destroy, doRun, equals, forCommandLine, forName, getTools, isStopped, postRun, preRun, run, runTool, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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, 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 of the window.

m_EndDate

protected BaseDateTime m_EndDate

the end date of the window.

Constructor Detail

AbstractTimeWindowDatabaseTool

public AbstractTimeWindowDatabaseTool()

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.