com.ergotech.vib.historical

Class DatabaseRawLookup

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

All Implemented Interfaces:

SimulationListener, ConnectionClosedListener

Direct Known Subclasses:

DatabaseArrayRawLookup, DatabaseRawTableLookup, DatabaseRawWrite, DatabaseRowArrayLookup

public class DatabaseRawLookup
extends DatabaseConnection

This server will take any SQL statement and return the first element of the first row returned from the query. Error Conditions: A failure caused by insufficient configuration (eg missing url, driver, etc.) or and error caused by a SQL Exception will cause a bad quality value to be sent from the component as well as an error string indication to be generated. A request that returns no data can be treated as an error, with a thrown exception, or not. In either case, any target will be updated with a repeat of the previous value with a bad quality.

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 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.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
DatabaseRawLookup() Create the component.

Method Summary

Modifier and Type	Method and Description
int	getDefaultQualityForLocation(int location) This is overridden to make the default quality for valueChanged be QUALITY_GOOD.
java.lang.String	getSQLStatement() Sets the SQL Statement to use for the query.
int	getStaticLocationFor(java.lang.String method) This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object.
boolean	isThrowOnNullResponse() True if the server will throw if no value is returned from the query.
void	prepareSQLStatement(java.lang.String sqlStatement) Sets the SQL Statement to use for the query.
void	refreshCurrentValue() Update the value.
ValueObjectInterface	retrieveValueObject() Returns a value object that represents the result of the SELECT query.
void	retrieveValues() Update the value.
void	setSQLStatement(java.lang.String sqlStatement) Sets the SQL Statement to use for the query.
void	setThrowOnNullResponse(boolean throwOnNullResponse) True if the server will throw if no value is returned from the query.
void	setValueObject(ValueObjectInterface newValue) Pass through to trigger(ValueChangedEvent) for compatibility in scripting.
void	trigger(ValueChangedEvent newEvent) This method will be called when a trigger is received.
void	valueChanged(int loc, ValueChangedEvent e) This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object.

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.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, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, 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

Constructor Detail

DatabaseRawLookup

public DatabaseRawLookup()

Create the component.

Method Detail

getDefaultQualityForLocation

public int getDefaultQualityForLocation(int location)
                                 throws BadParameterException

This is overridden to make the default quality for valueChanged be QUALITY_GOOD.

Overrides:

getDefaultQualityForLocation in class SimpleManipulator

Parameters:

loc - the location of the method.

Returns:

QUALITY_GOOD

Throws:

BadParameterException - never thrown.

getSQLStatement

public java.lang.String getSQLStatement()

Sets the SQL Statement to use for the query.

getStaticLocationFor

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

This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object. This will return 0 every time.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

isThrowOnNullResponse

public boolean isThrowOnNullResponse()

True if the server will throw if no value is returned from the query.

Returns:

Returns the throwOnNullResponse.

prepareSQLStatement

public void prepareSQLStatement(java.lang.String sqlStatement)
                         throws java.sql.SQLException

Sets the SQL Statement to use for the query.

Throws:

java.sql.SQLException

refreshCurrentValue

public void refreshCurrentValue()

Update the value.

Overrides:

refreshCurrentValue in class SimpleDataSource

retrieveValueObject

public ValueObjectInterface retrieveValueObject()
                                         throws java.sql.SQLException

Returns a value object that represents the result of the SELECT query. This may return null if there is no connection, or throw a SQLException if an error is reported from the database.

Throws:

java.sql.SQLException - thrown if the database reports an error

retrieveValues

public void retrieveValues()
                    throws VIBUpdateFailedException

Update the value.

Throws:

VIBUpdateFailedException

setSQLStatement

public void setSQLStatement(java.lang.String sqlStatement)

Sets the SQL Statement to use for the query.

Throws:

java.sql.SQLException

setThrowOnNullResponse

public void setThrowOnNullResponse(boolean throwOnNullResponse)

True if the server will throw if no value is returned from the query.

Parameters:

throwOnNullResponse - The throwOnNullResponse to set.

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Pass through to trigger(ValueChangedEvent) for compatibility in scripting.

Overrides:

setValueObject in class SimpleDataSource

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject

trigger

public void trigger(ValueChangedEvent newEvent)
             throws VIBUpdateFailedException

This method will be called when a trigger is received.

Throws:

VIBUpdateFailedException

valueChanged

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

This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object. This will call valuechanged every time.

Overrides:

valueChanged in class Manipulator

Throws:

BadParameterException

VIBUpdateFailedException