Package adams.run

Class RunDatabaseScheme

java.lang.Object

adams.core.logging.LoggingObject

adams.run.RunScheme

adams.run.RunDatabaseScheme

All Implemented Interfaces:

Destroyable, LoggingSupporter, OptionHandler, PasswordSupporter, SizeOfHandler, DatabaseConnectionEstablisher, DatabaseConnectionParameterHandler, Serializable

Direct Known Subclasses:

RunTool

public abstract class RunDatabaseScheme
extends RunScheme
implements DatabaseConnectionEstablisher, DatabaseConnectionParameterHandler

Abstract ancestor for RunSchemes that need to access the database.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseConnection	m_DbConn	database connection.
protected BasePassword	m_Password	the password of the database user.
protected String	m_URL	the JDBC URL to connect to.
protected String	m_User	the database user to use for connecting.

Fields inherited from class adams.run.RunScheme

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
RunDatabaseScheme()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
void	establishDatabaseConnection()	Establishes the database connection.
BasePassword	getPassword()	Returns the password of the database user.
String	getURL()	Returns the database URL being used.
String	getUser()	Returns the database user used for connecting.
protected void	initialize()	initializes member variables.
String	passwordTipText()	Returns the tip text for this property.
protected void	postRun()	Performs some output/cleanup after the actual run.
protected void	preRun()	Performs some initializations before the actual run.
void	setPassword(BasePassword value)	Sets the password of the database user.
void	setURL(String value)	Sets the database URL.
void	setUser(String value)	Sets the database user to use for connecting.
String	URLTipText()	Returns the tip text for this property.
String	userTipText()	Returns the tip text for this property.

Methods inherited from class adams.run.RunScheme

cleanUpOptions, destroy, doRun, forCommandLine, forName, getOptionManager, newOptionManager, run, runScheme, toCommandLine

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, toString, wait, wait, wait

Field Detail

m_DbConn

protected transient DatabaseConnection m_DbConn

database connection.

m_URL

protected String m_URL

the JDBC URL to connect to.

m_User

protected String m_User

the database user to use for connecting.

m_Password

protected BasePassword m_Password

the password of the database user.

Constructor Detail

RunDatabaseScheme

public RunDatabaseScheme()

Method Detail

initialize

protected void initialize()

initializes member variables.

Overrides:

initialize in class RunScheme

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class RunScheme

setURL

public void setURL(String value)

Sets the database URL.

Specified by:

setURL in interface DatabaseConnectionParameterHandler

Parameters:

value - the URL

getURL

public String getURL()

Returns the database URL being used.

Specified by:

getURL in interface DatabaseConnectionParameterHandler

Returns:

the URL

URLTipText

public String URLTipText()

Returns the tip text for this property.

Specified by:

URLTipText in interface DatabaseConnectionParameterHandler

Returns:

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

setUser

public void setUser(String value)

Sets the database user to use for connecting.

Specified by:

setUser in interface DatabaseConnectionParameterHandler

Parameters:

value - the user

getUser

public String getUser()

Returns the database user used for connecting.

Specified by:

getUser in interface DatabaseConnectionParameterHandler

Returns:

the user

userTipText

public String userTipText()

Returns the tip text for this property.

Specified by:

userTipText in interface DatabaseConnectionParameterHandler

Returns:

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

setPassword

public void setPassword(BasePassword value)

Sets the password of the database user.

Specified by:

setPassword in interface DatabaseConnectionParameterHandler

Specified by:

setPassword in interface PasswordSupporter

Parameters:

value - the password

getPassword

public BasePassword getPassword()

Returns the password of the database user.

Specified by:

getPassword in interface DatabaseConnectionParameterHandler

Specified by:

getPassword in interface PasswordSupporter

Returns:

the password

passwordTipText

public String passwordTipText()

Returns the tip text for this property.

Specified by:

passwordTipText in interface DatabaseConnectionParameterHandler

Returns:

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

establishDatabaseConnection

public void establishDatabaseConnection()

Establishes the database connection.

Specified by:

establishDatabaseConnection in interface DatabaseConnectionEstablisher

preRun

protected void preRun()
               throws Exception

Performs some initializations before the actual run. Connects to the database.

Overrides:

preRun in class RunScheme

Throws:

Exception - if something goes wrong

postRun

protected void postRun()
                throws Exception

Performs some output/cleanup after the actual run. Disconnects from the database.

Overrides:

postRun in class RunScheme

Throws:

Exception - if something goes wrong