com.ergotech.vib.historical

Class HistoricalDatabaseServer

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.HistoricalDatabaseServer

All Implemented Interfaces:

SimulationListener, ConnectionClosedListener, java.lang.Runnable

public class HistoricalDatabaseServer
extends DatabaseConnection
implements java.lang.Runnable

This server retrieves data stored to a JDBC database which has a "triggered historical" type table. The data must be in the format stored by a "TriggeredHistorical" manipulator. The only requirement is a timestamp column and one or more data columns.

Historical Package Only

See Also:

DatabaseConnection.getTableName(), getDateColumnName(), TriggeredHistorical

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.

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

Method Summary

Modifier and Type	Method and Description
ValueObjectInterface	authenticatedClientRequest(java.lang.String name, int requestId, ValueObjectInterface value) Test only....
ValueObjectInterface	create(java.util.Date startDate, java.util.Date endDate) This is called whenever the ValueChangedEvent is triggered.
java.lang.String	getColumnNames() Returns the comma delimited list of column names
java.lang.String	getDateColumnName() Returns the applicationName of the table.
java.lang.String	getDefaultLookback() gets the default lookback period (data period to fetch from the database)
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	run() This is where we will process the requests.
void	setColumnNames(java.lang.String columnNames) A comma delimited list of the column names to read.
void	setDateColumnName(java.lang.String dateColumnName) Sets the applicationName of the table.
void	setDefaultLookback(java.lang.String newValue) Set the default lookback period.
void	trigger(ValueChangedEvent newEvent) This method will be called when the default input data source(s) change value
void	update(java.util.Date startDate, java.util.Date endDate) The type of each column.
void	valueChanged(int loc, ValueChangedEvent e) This allows the for a staticmethodevent to occur.

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

connectionClosed, eventInfo, getConnectionName, getConsoleReport, getDataBaseType, getTableName, isCreateIndex, isCreateTable, isMillisPrecision, isSynchronizeConnection, logInfo, messageString, setConnectionName, setConsoleReport, setCreateIndex, setCreateTable, 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, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueInput

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, 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

Constructor Detail

HistoricalDatabaseServer

public HistoricalDatabaseServer()

Method Detail

authenticatedClientRequest

public ValueObjectInterface authenticatedClientRequest(java.lang.String name,
                                                       int requestId,
                                                       ValueObjectInterface value)
                                                throws VIBUpdateFailedException

Test only.... This will send a few values tagged between the start and end of a DateRangeValueObject... for one line lo - hi

Overrides:

authenticatedClientRequest in class SimpleDataSource

Throws:

VIBUpdateFailedException

create

public ValueObjectInterface create(java.util.Date startDate,
                                   java.util.Date endDate)

This is called whenever the ValueChangedEvent is triggered. The current value of the selected bit is calculated and set for the manipulator value.

getColumnNames

public java.lang.String getColumnNames()

Returns the comma delimited list of column names

getDateColumnName

public java.lang.String getDateColumnName()

Returns the applicationName of the table.

Overrides:

getDateColumnName in class DatabaseConnection

Returns:

Returns the dateColumnName.

getDefaultLookback

public java.lang.String getDefaultLookback()

gets the default lookback period (data period to fetch from the database)

See Also:

setDefaultLookback(java.lang.String)

getStaticLocationFor

public int getStaticLocationFor(java.lang.String loc)
                         throws BadParameterException

This is used by the StaticMethodEvent to determine which valueChanged method to call. An integer index is returned which is used by the valueChanged (int,ValueChangedEvent) method.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

run

public void run()

This is where we will process the requests. This is in a seperate Thread since most requests take some time... and happen on the event thread (so everything stops).

Specified by:

run in interface java.lang.Runnable

setColumnNames

public void setColumnNames(java.lang.String columnNames)

A comma delimited list of the column names to read.

setDateColumnName

public void setDateColumnName(java.lang.String dateColumnName)

Sets the applicationName of the table.

Overrides:

setDateColumnName in class DatabaseConnection

Parameters:

dateColumnName - The dateColumnName to set.

setDefaultLookback

public void setDefaultLookback(java.lang.String newValue)

Set the default lookback period. This is the data period read from the database if a date range is not set. It is a number followed by an h, m, or d, to indicate hours, minutes, or days. If the h, m, or d is not at the end of the String, then hours is assumed.

Parameters:

newValue - the lookback time as a String

trigger

public void trigger(ValueChangedEvent newEvent)
             throws VIBUpdateFailedException

This method will be called when the default input data source(s) change value

Throws:

VIBUpdateFailedException

update

public void update(java.util.Date startDate,
                   java.util.Date endDate)
            throws VIBUpdateFailedException

The type of each column.

Throws:

VIBUpdateFailedException

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This allows the for a staticmethodevent to occur.

Overrides:

valueChanged in class Manipulator

Throws:

BadParameterException

VIBUpdateFailedException