com.ergotech.vib.historical

Class DatabaseConnection

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.historical.DatabaseConnection

All Implemented Interfaces:

SimulationListener, ConnectionClosedListener

Direct Known Subclasses:

CachedDatabaseConnection, DatabaseColumnMetaDataArray, DatabaseRawLookup, DatabaseTableMetaDataArray, HistoricalDatabaseServer

public abstract class DatabaseConnection
extends SimpleManipulator
implements ConnectionClosedListener, SimulationListener

This is the superclass for historical manipulators. It handles the editing/creation of a connection.

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	alwaysCloseConnection This will be set to true if an IllegalMonitorStateException is thrown when dealing with the connection.
static int	debugLevel The debug level for this bean.
static int	HSQLDB The connection is to HSQLDB.
java.text.DateFormat	logDateFormat used for all the debugLevel/consoleReport logging
static int	MYSQL The connection is to MYSQL.
static int	ORACLE The connection is to ORACLE.
static int	OTHER The connection is to a database we don't have an interest in.
static int	POSTGRES The connection is to SQLITE.
static int	SQLITE The connection is to SQLITE.

Fields inherited from class com.ergotech.vib.manipulators.SimpleManipulator

cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Fields inherited from interface com.ergotech.vib.historical.ConnectionClosedListener

cvsRev

Constructor Summary

Constructors

Constructor and Description
DatabaseConnection()

Method Summary

Modifier and Type	Method and Description
void	connectionClosed(ConnectionClosedEvent cce) This method is called by the connection pool when a (the?) connection to the database is closed.
java.lang.String	eventInfo(ValueChangedEvent e)
java.lang.String	getConnectionName()
boolean	getConsoleReport() gets whether or not a console report is desired.
int	getDataBaseType() This method will return one of the defined constants for the connection type.
java.lang.String	getDateColumnName()
java.lang.String	getTableName() Returns the name of the table.
boolean	isCreateIndex()
boolean	isCreateTable()
boolean	isMillisPrecision()
boolean	isSynchronizeConnection()
void	logInfo(java.lang.String msg) Logs messages for debugLevel and/or consoleReport settings.
void	messageString(java.lang.String msg) Logs error and some informational messages.
void	setConnectionName(java.lang.String connectionName)
void	setConsoleReport(boolean newValue) sets whether or not a console report is desired.
void	setCreateIndex(boolean createIndex)
void	setCreateTable(boolean createTable)
void	setDateColumnName(java.lang.String dateColumnName)
void	setMillisPrecision(boolean millisPrecision)
void	setSimulationFlag(boolean simulationFlag) Sets the state of the simulation flag.
void	setSynchronizeConnection(boolean synchronizeConnection)
void	setTableName(java.lang.String tableName) Sets the name of the table.
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) Changes the state of the simulation mode.
void	start() Enable data saving and attempt a save if a trigger has been seen.
void	stop() Close the connection.
boolean	tableExists(java.lang.String tableName) Returns true if the given tablename exists in the database, otherwise false.
java.lang.String	toString() Provides the internal byte and array output as a String.

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueChanged, valueInput

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

alwaysCloseConnection

public static boolean alwaysCloseConnection

This will be set to true if an IllegalMonitorStateException is thrown when dealing with the connection. The only platform on which this is known to happen is the NWM and on that platform, the database connection must be opened and closed with each operation

debugLevel

public static int debugLevel

The debug level for this bean. It will be set by a system property called historical.debuglevel.

HSQLDB

public static final int HSQLDB

The connection is to HSQLDB.

See Also:

Constant Field Values

logDateFormat

public java.text.DateFormat logDateFormat

used for all the debugLevel/consoleReport logging

MYSQL

public static final int MYSQL

The connection is to MYSQL.

See Also:

Constant Field Values

ORACLE

public static final int ORACLE

The connection is to ORACLE.

See Also:

Constant Field Values

OTHER

public static final int OTHER

The connection is to a database we don't have an interest in.

See Also:

Constant Field Values

POSTGRES

public static final int POSTGRES

The connection is to SQLITE.

See Also:

Constant Field Values

SQLITE

public static final int SQLITE

The connection is to SQLITE.

See Also:

Constant Field Values

Constructor Detail

DatabaseConnection

public DatabaseConnection()

Method Detail

connectionClosed

public void connectionClosed(ConnectionClosedEvent cce)

This method is called by the connection pool when a (the?) connection to the database is closed.

Specified by:

connectionClosed in interface ConnectionClosedListener

eventInfo

public java.lang.String eventInfo(ValueChangedEvent e)

Returns:

a string with information about a trigger event, used for logging

getConnectionName

public java.lang.String getConnectionName()

Returns:

Returns the connectionName.

getConsoleReport

public boolean getConsoleReport()

gets whether or not a console report is desired.

getDataBaseType

public int getDataBaseType()
                    throws java.sql.SQLException

This method will return one of the defined constants for the connection type.

Throws:

java.sql.SQLException

getDateColumnName

public java.lang.String getDateColumnName()

Returns:

Returns the dateColumnName.

getTableName

public java.lang.String getTableName()

Returns the name of the table.

isCreateIndex

public boolean isCreateIndex()

isCreateTable

public boolean isCreateTable()

Returns:

Returns the createTable.

isMillisPrecision

public boolean isMillisPrecision()

isSynchronizeConnection

public boolean isSynchronizeConnection()

Returns:

Returns the synchronizeConnection.

logInfo

public void logInfo(java.lang.String msg)

Logs messages for debugLevel and/or consoleReport settings. Informational only, no errors

messageString

public void messageString(java.lang.String msg)

Logs error and some informational messages. This will also be captured as the output for the messageString output.

setConnectionName

public void setConnectionName(java.lang.String connectionName)

Parameters:

connectionName - The connectionName to set.

setConsoleReport

public void setConsoleReport(boolean newValue)

sets whether or not a console report is desired.

setCreateIndex

public void setCreateIndex(boolean createIndex)

setCreateTable

public void setCreateTable(boolean createTable)

Parameters:

createTable - The createTable to set.

setDateColumnName

public void setDateColumnName(java.lang.String dateColumnName)

Parameters:

dateColumnName - The dateColumnName to set.

setMillisPrecision

public void setMillisPrecision(boolean millisPrecision)

setSimulationFlag

public void setSimulationFlag(boolean simulationFlag)

Sets the state of the simulation flag.

Specified by:

setSimulationFlag in interface SimulationListener

Parameters:

simulationFlag - will be written as "false" when code is generated.

setSynchronizeConnection

public void setSynchronizeConnection(boolean synchronizeConnection)

Parameters:

synchronizeConnection - The synchronizeConnection to set.

setTableName

public void setTableName(java.lang.String tableName)

Sets the name of the table.

simulationStateChanged

public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                            throws java.lang.Exception

Changes the state of the simulation mode. If this flag is true, then any existing connections will be closed and no new connections will be opened. The flag should be false for normal operation.

Specified by:

simulationStateChanged in interface SimulationListener

Throws:

java.lang.Exception - TODO

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Enable data saving and attempt a save if a trigger has been seen. Add simulation listener.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

stop

public void stop()
          throws BadParameterException

Close the connection. Remove the simulation listener.

Overrides:

stop in class SimpleDataSource

Throws:

BadParameterException

tableExists

public boolean tableExists(java.lang.String tableName)
                    throws java.sql.SQLException

Returns true if the given tablename exists in the database, otherwise false.

Parameters:

tableName - the table name to check for

Returns:

true if the table exists, otherwise false.

Throws:

java.sql.SQLException - thrown if the database cannot be contacted or other error.

toString

public java.lang.String toString()

Provides the internal byte and array output as a String.

Overrides:

toString in class Manipulator

Returns:

a string description of this server and an error message, if any