com.inductiveautomation.gateway.tags.history.storage

Class TagHistoryDatasourceSink

java.lang.Object

com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractSink

com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractDatasourceSink

com.inductiveautomation.gateway.tags.history.storage.TagHistoryDatasourceSink

All Implemented Interfaces:

DataSink, HistoryStorer

Direct Known Subclasses:

LocalHistorianSink

public class TagHistoryDatasourceSink
extends AbstractDatasourceSink

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	checkEnabled

Fields inherited from class com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractSink

faulted, faultError, faultTime

Fields inherited from interface com.inductiveautomation.ignition.gateway.history.DataSink

LOG_NAME_TEMPLATE, ROOT_LOGGER

Constructor Summary

Constructors

Constructor and Description
TagHistoryDatasourceSink(GatewayContext context, SQLTagHistoryProviderRecord profile, TagHistorianSettingsRecord settings)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Integer	_getProviderId(java.lang.String providerId)
boolean	acceptsData(HistoryFlavor dataType) Returns whether or not the storer can accept the specified type of data.
protected com.google.common.collect.Multimap<java.lang.String,HistoricalTagValue>	breakupByPartition(ScanclassHistorySet theData)
protected void	checkTables()
protected PartitionManager	createPartitionManager()
protected java.lang.String	getDescriptionKey()
protected int	getIdOfScanclassName(java.lang.String providerName, java.lang.String scName) Gets the id of the given SC name, inserting if necessary.
protected java.lang.String	getKeyForTagIdCache(int providerId, java.lang.String path)
protected PartitionManager	getPartitionManager()
protected int	getProviderId(java.lang.String providerName, boolean create) Returns the id of the specified provider, for this system.
protected int	getSystemId() Get the id of the driver.
protected java.util.Map<java.lang.String,HistoricalTagInfo>	getTagIds(ScanclassHistorySet data)
protected void	initialize()
protected void	insertProviderName(java.lang.String providerName)
protected void	insertTagValues(SRConnection conn, ScanclassHistorySet theData) Actually inserts the tag values in to the Tag Value table.
boolean	isAccepting() Returns whether the data store is accepting data.
boolean	isLicensedFor(HistoryFlavor dataType) Assuming the storer accepts the flavor, is it currently licensed for it? If not, the data will not be stored.
protected boolean	isOurProviderId(java.lang.Integer value) Returns whether the provider id is from this driver *
protected void	loadProviderIds()
protected void	loadTagIdCache()
protected void	retireTags(java.util.List<HistoricalTagInfo> toRetire)
protected void	retireTags(SRConnection conn, java.util.List<TagPath> paths) Marks the given paths as retired, and removes them from the cache.
void	setDatasourceName(java.lang.String dataSource)
void	shutdown()
protected void	startMaintenanceTasks() If a maintenance task is defined, and we've been initialized (determined by the presence of Partition Manager), will register the tag with the execution engine.
protected void	startOptimizeEngine()
void	startup()
protected void	stopMaintenanceTasks()
protected void	storeDataToDatasource(SRConnection conn, HistoricalData data) Stores the given data against the connection which has been pre-setup to execute in a transaction.
protected void	storeScanClassSet(SRConnection conn, ScanclassHistorySet data)
protected void	storeValueToOptimized(HistoricalTagValue v, int tagid, long ts)
protected boolean	tryToInit() Initialization is really complex in this class because we don't really want to initialize until data comes in.
protected void	updateSCExecRecord(SRConnection conn, java.lang.String provName, java.lang.String scName, int rate, java.util.Date execTime) This class updates the scan class execution table.
void	updateSettings(SQLTagHistoryProviderRecord profile, TagHistorianSettingsRecord settings)
protected void	updateSystemName(java.lang.String newName)
protected boolean	useSCE(ScanclassHistorySet data)

Methods inherited from class com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractDatasourceSink

getContext, getDatasource, getDatasourceName, getInfo, getQueryCache, runFirstTimeChecks, storeData, storeToDatasource, useBatching, useGeneratedKeys

Methods inherited from class com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractSink

createLogger, getLogger, getLogName, getPipelineName, getQuarantineManager, isFaulted, isInitialized, isStarted, setFaulted, setInitialized, uninitialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

checkEnabled

protected boolean checkEnabled

Constructor Detail

TagHistoryDatasourceSink

public TagHistoryDatasourceSink(GatewayContext context,
                                SQLTagHistoryProviderRecord profile,
                                TagHistorianSettingsRecord settings)

Method Detail

updateSettings

public void updateSettings(SQLTagHistoryProviderRecord profile,
                           TagHistorianSettingsRecord settings)

setDatasourceName

public void setDatasourceName(java.lang.String dataSource)

Overrides:

setDatasourceName in class AbstractDatasourceSink

getDescriptionKey

protected java.lang.String getDescriptionKey()

Specified by:

getDescriptionKey in class AbstractDatasourceSink

acceptsData

public boolean acceptsData(HistoryFlavor dataType)

Description copied from interface: HistoryStorer

Returns whether or not the storer can accept the specified type of data.

Returns:

isLicensedFor

public boolean isLicensedFor(HistoryFlavor dataType)

Description copied from interface: HistoryStorer

Assuming the storer accepts the flavor, is it currently licensed for it? If not, the data will not be stored.

Returns:

tryToInit

protected boolean tryToInit()

Initialization is really complex in this class because we don't really want to initialize until data comes in. So, we have to prevent init, but also claim to accept, until we get the first data.

Overrides:

tryToInit in class AbstractSink

startup

public void startup()

Specified by:

startup in interface DataSink

Overrides:

startup in class AbstractSink

initialize

protected void initialize()
                   throws java.lang.Exception

Overrides:

initialize in class AbstractSink

Throws:

java.lang.Exception

startOptimizeEngine

protected void startOptimizeEngine()

createPartitionManager

protected PartitionManager createPartitionManager()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface DataSink

Overrides:

shutdown in class AbstractSink

isAccepting

public boolean isAccepting()

Description copied from interface: DataSink

Returns whether the data store is accepting data.

Specified by:

isAccepting in interface DataSink

Overrides:

isAccepting in class AbstractDatasourceSink

Returns:

getPartitionManager

protected PartitionManager getPartitionManager()

useSCE

protected boolean useSCE(ScanclassHistorySet data)

storeDataToDatasource

protected void storeDataToDatasource(SRConnection conn,
                                     HistoricalData data)
                              throws java.lang.Exception

Stores the given data against the connection which has been pre-setup to execute in a transaction. Any error that occurs will cause the transaction to roll back.

Specified by:

storeDataToDatasource in class AbstractDatasourceSink

Throws:

java.lang.Exception

storeScanClassSet

protected void storeScanClassSet(SRConnection conn,
                                 ScanclassHistorySet data)
                          throws java.lang.Exception

Throws:

java.lang.Exception

loadProviderIds

protected void loadProviderIds()
                        throws java.lang.Exception

Throws:

java.lang.Exception

insertProviderName

protected void insertProviderName(java.lang.String providerName)
                           throws java.lang.Exception

Throws:

java.lang.Exception

_getProviderId

protected java.lang.Integer _getProviderId(java.lang.String providerId)

isOurProviderId

protected boolean isOurProviderId(java.lang.Integer value)

Returns whether the provider id is from this driver *

getSystemId

protected int getSystemId()
                   throws java.lang.Exception

Get the id of the driver. Will look it up/insert the driver if necessary.

Parameters:

conn -

systemName -

Returns:

Throws:

java.lang.Exception

updateSystemName

protected void updateSystemName(java.lang.String newName)

getProviderId

protected int getProviderId(java.lang.String providerName,
                            boolean create)
                     throws java.lang.Exception

Returns the id of the specified provider, for this system. If provider name is null, the system id will be returned. If create is true, the id will be inserted if necessary.

Throws:

java.lang.Exception

startMaintenanceTasks

protected void startMaintenanceTasks()

If a maintenance task is defined, and we've been initialized (determined by the presence of Partition Manager), will register the tag with the execution engine.

stopMaintenanceTasks

protected void stopMaintenanceTasks()

updateSCExecRecord

protected void updateSCExecRecord(SRConnection conn,
                                  java.lang.String provName,
                                  java.lang.String scName,
                                  int rate,
                                  java.util.Date execTime)
                           throws java.lang.Exception

This class updates the scan class execution table. This function updates an existing row with: matching name, matching rate, and end_time>(exec-2*rate). If nothing matches, a new row is inserted.

A special case, however, occurs when rate==0. This indicates that the scan class does not run regularly. In this case, nothing will happen.

Parameters:

conn -

scName -

rate -

execTime -

Throws:

java.lang.Exception

getIdOfScanclassName

protected int getIdOfScanclassName(java.lang.String providerName,
                                   java.lang.String scName)
                            throws java.lang.Exception

Gets the id of the given SC name, inserting if necessary.

Parameters:

conn -

scName -

Returns:

Throws:

java.lang.Exception

getKeyForTagIdCache

protected java.lang.String getKeyForTagIdCache(int providerId,
                                               java.lang.String path)

loadTagIdCache

protected void loadTagIdCache()
                       throws java.lang.Exception

Throws:

java.lang.Exception

getTagIds

protected java.util.Map<java.lang.String,HistoricalTagInfo> getTagIds(ScanclassHistorySet data)
                                                               throws java.lang.Exception

Throws:

java.lang.Exception

retireTags

protected void retireTags(SRConnection conn,
                          java.util.List<TagPath> paths)
                   throws java.lang.Exception

Marks the given paths as retired, and removes them from the cache. This is used when tags are deleted from the system. The getTagIds() function also retires tags when necessary.

Parameters:

conn -

paths -

Throws:

java.lang.Exception

retireTags

protected void retireTags(java.util.List<HistoricalTagInfo> toRetire)
                   throws java.lang.Exception

Throws:

java.lang.Exception

insertTagValues

protected void insertTagValues(SRConnection conn,
                               ScanclassHistorySet theData)
                        throws java.lang.Exception

Actually inserts the tag values in to the Tag Value table.

Parameters:

conn -

theData -

scid -

Throws:

java.lang.Exception

breakupByPartition

protected com.google.common.collect.Multimap<java.lang.String,HistoricalTagValue> breakupByPartition(ScanclassHistorySet theData)
                                                                                              throws java.lang.Exception

Throws:

java.lang.Exception

storeValueToOptimized

protected void storeValueToOptimized(HistoricalTagValue v,
                                     int tagid,
                                     long ts)

checkTables

protected void checkTables()
                    throws java.lang.Exception

Throws:

java.lang.Exception