com.ergotech.vib.historical

Class TriggeredHistorical

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

com.ergotech.vib.historical.TriggeredHistorical

All Implemented Interfaces:

SimulationListener, ConnectionClosedListener

public class TriggeredHistorical
extends CachedDatabaseConnection

This manipulator will store multiple values to a database whenever it is triggered. it is triggered on any data change from the "trigger" data source. The format of the database for this object is a table with the provided tableName and a column of that will accept a "timestamp" object that has the name provided by the "dateColumnName". The timestamp column is a time that combines both the date and time value. The rest of the table must be columns that match the names of the provided data sources or of the Connectors. For example suppose that the table is called "HISTORICAL" and the date column is called "READINGTIME" and there are three data sources attached and the tagnames are "tag1", "tag2", "tag3" then the HISTORICAL table should have these columns:

TAG1, TAG2, TAG3, READINGTIME

. A name can be assigned to the Connector which will override the name on the component. Since the Connector names need not be unique, this allows access to different tables, or multiple access to the same tables, where the column names are the same. That is, if two tables have a column "MYVALUE" then a component naming conflict can be avoided by naming the connectors. The types of the column are checked and automatic conversion will take place if needed. The primary output of this bean is true/false indicating the status of the last save attempt. The "CacheSize" output indicates the number of elements currently in the cache, which will be non-zero if caching is enabled and active. The "MessageStrings" output indicates the last recorded error as reported from the database or an empty string if no error was reported. If the write to the database fails, and the data is not successfully cached then the "trigger" method will throw a VIBUpdateFailedException. If the data is successfully cached, even if the write was unsuccessful, then the method will not throw. The "MessageStrings" output will indicate the error and the "CacheSize" will show the number of elements currently in the cache.

Historical Package Only

See Also:

DatabaseConnection.getTableName(), getDateColumnName(), HistoricalDatabaseServer

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
int	saveQualityBetterThanOrEqualTo The quality of a value must be better than this in order for a value to be saved.

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

cvsRev, DELETE_OLDEST, IGNORE_NEW, THROW

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
TriggeredHistorical() Create the manipulator.

Method Summary

Modifier and Type	Method and Description
void	destroy() Stop the data source and unregister us from the event listener.
java.util.List<java.lang.String>	getColumns()
java.util.List<java.lang.Integer>	getColumnTypes()
java.lang.String	getDateColumnName() Returns the applicationName of the table.
int	getSaveQualityBetterThan() The quality of a value must be better than this in order to be saved.
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	jsonTrigger(ValueChangedEvent newEvent) This method triggers a write to the database.
void	mapTrigger(ValueChangedEvent newEvent) This method triggers a write to the database.
void	pushCache(ValueChangedEvent newEvent) This method will attempt to flush the database cache to the database, but without writing a new value.
void	setColumns(java.util.List<java.lang.String> columns)
void	setColumnTypes(java.util.List<java.lang.Integer> columnTypes)
void	setConnectionName(java.lang.String connectionName)
void	setDateColumnName(java.lang.String dateColumnName) Sets the applicationName of the table.
void	setSaveQualityBetterThan(int saveQualityBetterThanOrEqualTo) The quality of a value must be better than this in order to be saved.
void	start() Enable data saving and attempt a save if a trigger has been seen.
void	trigger(ValueChangedEvent newEvent) This method triggers a write to the database.
boolean	update(long triggerTime, java.util.Map<java.lang.String,ValueObjectInterface> values, int expectedCount) This is called whenever the manipulator is triggered.
boolean	updateWithMap(long timestamp, java.util.Map<java.lang.String,ValueObjectInterface> values, boolean writeNew) Save the contents of the map to the database.
void	valueChanged(int loc, ValueChangedEvent e) This allows the for a staticmethodevent to occur.
void	valueInput(ValueChangedEvent newEvent) This method accepts the new values that are to be stored to the database.
void	VIBEvent(VIBEvent theEvent) We are interested in few events.

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

getCachedValueAt, getCacheFullBehavior, getCacheSize, setCacheFullBehavior, setCacheSize

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

connectionClosed, eventInfo, getConnectionName, getConsoleReport, getDataBaseType, getTableName, isCreateIndex, isCreateTable, isMillisPrecision, isSynchronizeConnection, logInfo, messageString, setConsoleReport, setCreateIndex, setCreateTable, setMillisPrecision, setSimulationFlag, setSynchronizeConnection, setTableName, simulationStateChanged, 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

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

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

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

saveQualityBetterThanOrEqualTo

public int saveQualityBetterThanOrEqualTo

The quality of a value must be better than this in order for a value to be saved.

Constructor Detail

TriggeredHistorical

public TriggeredHistorical()

Create the manipulator.

Method Detail

destroy

public void destroy()
             throws BadParameterException

Stop the data source and unregister us from the event listener.

Overrides:

destroy in class SimpleDataSource

Throws:

BadParameterException

See Also:

SimpleDataSource.stop()

getColumns

public java.util.List<java.lang.String> getColumns()

getColumnTypes

public java.util.List<java.lang.Integer> getColumnTypes()

getDateColumnName

public java.lang.String getDateColumnName()

Returns the applicationName of the table.

Overrides:

getDateColumnName in class DatabaseConnection

Returns:

Returns the dateColumnName.

getSaveQualityBetterThan

public int getSaveQualityBetterThan()

The quality of a value must be better than this in order to be saved.

Returns:

Returns the saveQualityBetterThanOrEqualTo.

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

jsonTrigger

public void jsonTrigger(ValueChangedEvent newEvent)
                 throws VIBUpdateFailedException

This method triggers a write to the database. If the write to the database fails, and the data is not successfully cached then the "trigger" method will throw a VIBUpdateFailedException. If the data is successfully cached, even if the write was unsuccessful, then the method will not throw. The "MessageStrings" output will indicate the error and the "CacheSize" will show the number of elements currently in the cache. The value object passed to this method is a ValueObject containing a JSON map that contains the values to be written to the database. The JSON Map should contain only simple values, that is recusive complex data structures (eg maps in maps) is not supported.

Parameters:

newEvent - the event causing the write. The time of the event is used as the value of the timestamp for the write, the value is otherwise ignored.

Throws:

VIBUpdateFailedException - If the write to the database fails and the data is not successfully cached.

mapTrigger

public void mapTrigger(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This method triggers a write to the database. If the write to the database fails, and the data is not successfully cached then the "trigger" method will throw a VIBUpdateFailedException. If the data is successfully cached, even if the write was unsuccessful, then the method will not throw. The "MessageStrings" output will indicate the error and the "CacheSize" will show the number of elements currently in the cache. The value object passed to this method is a ValueObject which contains the property "MAP" that referencesa Map that contains the values to be written to the database. The value contained in the value object is ignored, only the map is used.

Parameters:

newEvent - the event causing the write. The time of the event is used as the value of the timestamp for the write, the value is otherwise ignored.

Throws:

VIBUpdateFailedException - If the write to the database fails and the data is not successfully cached.

pushCache

public void pushCache(ValueChangedEvent newEvent)
               throws VIBUpdateFailedException

This method will attempt to flush the database cache to the database, but without writing a new value.

Parameters:

newEvent - the event causing the write. The time of the event is used as the value of the timestamp for the write, the value is otherwise ignored.

Throws:

VIBUpdateFailedException - If the write to the database fails and the data is not successfully cached.

setColumns

public void setColumns(java.util.List<java.lang.String> columns)

setColumnTypes

public void setColumnTypes(java.util.List<java.lang.Integer> columnTypes)

setConnectionName

public void setConnectionName(java.lang.String connectionName)

Overrides:

setConnectionName in class DatabaseConnection

Parameters:

connectionName - The connectionName to set.

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.

setSaveQualityBetterThan

public void setSaveQualityBetterThan(int saveQualityBetterThanOrEqualTo)

The quality of a value must be better than this in order to be saved.

Parameters:

saveQualityBetterThanOrEqualTo - The saveQualityBetterThanOrEqualTo to set.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

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

Overrides:

start in class DatabaseConnection

Throws:

BadParameterException

VIBUpdateFailedException

trigger

public void trigger(ValueChangedEvent newEvent)
             throws VIBUpdateFailedException

This method triggers a write to the database. If the write to the database fails, and the data is not successfully cached then the "trigger" method will throw a VIBUpdateFailedException. If the data is successfully cached, even if the write was unsuccessful, then the method will not throw. The "MessageStrings" output will indicate the error and the "CacheSize" will show the number of elements currently in the cache.

Parameters:

newEvent - the event causing the write. The time of the event is used as the value of the timestamp for the write, the value is otherwise ignored.

Throws:

VIBUpdateFailedException - If the write to the database fails and the data is not successfully cached.

update

public boolean update(long triggerTime,
                      java.util.Map<java.lang.String,ValueObjectInterface> values,
                      int expectedCount)

This is called whenever the manipulator is triggered. This will store the data into the database.

Parameters:

triggerTime - the time to assoicate with the values

values - the values to store

expectedCount - the expected number of values that will be stored.

Returns:

updateWithMap

public boolean updateWithMap(long timestamp,
                             java.util.Map<java.lang.String,ValueObjectInterface> values,
                             boolean writeNew)

Save the contents of the map to the database. Save the cache first and cache the values if writing to the database fails.

Parameters:

timestamp - the timestamp associated with the values

values - the values to save

writeNew - whether new values should be stored to the database (or just the cached values)

Returns:

true if all the data was successfully saved

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:

VIBUpdateFailedException

BadParameterException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This method accepts the new values that are to be stored to the database. The values will be recorded to the database only when a value is sent to the "trigger" input.

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException

VIBEvent

public void VIBEvent(VIBEvent theEvent)
              throws BadParameterException

We are interested in few events. These are used so we can reregister for a server.

Overrides:

VIBEvent in class SimpleDataSource

Throws:

BadParameterException