com.ergotech.vib.historical

Class CachedDatabaseConnection

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

com.ergotech.vib.historical.CachedDatabaseConnection

All Implemented Interfaces:

SimulationListener, ConnectionClosedListener

Direct Known Subclasses:

TriggeredHistorical

public abstract class CachedDatabaseConnection
extends DatabaseConnection

This is the superclass for historical manipulators. It handles the editing/creation of a connection. This component also supports a cache of values, providing storage in cases where the historical manipulator cannot contact the database.

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 java.lang.String	cvsRev The CVS Revision String.
static int	DELETE_OLDEST If the cacheFullBehavior is set to this parameter the oldest data in the cache will be deleted and so lost.
static int	IGNORE_NEW If the cacheFullBehavior is set to this parameter new data received will not be cached and so will be lost.
static int	THROW If the cacheFullBehavior is set to this parameter the application will throw an exception to indicate the error and so stop all further processing.

Fields inherited from class com.ergotech.vib.historical.DatabaseConnection

alwaysCloseConnection, debugLevel, HSQLDB, logDateFormat, MYSQL, ORACLE, OTHER, POSTGRES, SQLITE

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

Constructor Summary

Constructors

Constructor and Description
CachedDatabaseConnection()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,ValueObjectInterface>	getCachedValueAt(int index) This returns the currently cached values (used for unit testing).
int	getCacheFullBehavior() This maintains the behavior of the cache when full.
int	getCacheSize() This is the maximum cache size.
void	setCacheFullBehavior(int cacheFullBehavior) This maintains the behavior of the cache when full.
void	setCacheSize(int newValue) This is the maximum cache size.

Methods inherited from class com.ergotech.vib.historical.DatabaseConnection

connectionClosed, eventInfo, getConnectionName, getConsoleReport, getDataBaseType, getDateColumnName, getTableName, isCreateIndex, isCreateTable, isMillisPrecision, isSynchronizeConnection, logInfo, messageString, setConnectionName, setConsoleReport, setCreateIndex, setCreateTable, setDateColumnName, setMillisPrecision, setSimulationFlag, setSynchronizeConnection, setTableName, simulationStateChanged, start, stop, tableExists, toString

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

cvsRev

public static final java.lang.String cvsRev

The CVS Revision String.

See Also:

Constant Field Values

DELETE_OLDEST

public static final int DELETE_OLDEST

If the cacheFullBehavior is set to this parameter the oldest data in the cache will be deleted and so lost.

See Also:

Constant Field Values

IGNORE_NEW

public static final int IGNORE_NEW

If the cacheFullBehavior is set to this parameter new data received will not be cached and so will be lost.

See Also:

Constant Field Values

THROW

public static final int THROW

If the cacheFullBehavior is set to this parameter the application will throw an exception to indicate the error and so stop all further processing. This is the same as IGNORE_NEW if the error is not handled.

See Also:

Constant Field Values

Constructor Detail

CachedDatabaseConnection

public CachedDatabaseConnection()

Method Detail

getCachedValueAt

public java.util.Map<java.lang.String,ValueObjectInterface> getCachedValueAt(int index)

This returns the currently cached values (used for unit testing).

getCacheFullBehavior

public int getCacheFullBehavior()

This maintains the behavior of the cache when full. It should be one of the defined constants.

Returns:

Returns the cacheFullBehavior.

getCacheSize

public int getCacheSize()

This is the maximum cache size.

See Also:

setCacheSize

setCacheFullBehavior

public void setCacheFullBehavior(int cacheFullBehavior)

This maintains the behavior of the cache when full. It should be one of the defined constants.

Parameters:

cacheFullBehavior - The cacheFullBehavior to set.

setCacheSize

public void setCacheSize(int newValue)

This is the maximum cache size.

See Also:

getCacheSize