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

Class AbstractDatasourceSink

java.lang.Object

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

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

All Implemented Interfaces:

DataSink, HistoryStorer, IRecordListener<DatasourceRecord>

Direct Known Subclasses:

TagHistoryDatasourceSink

public abstract class AbstractDatasourceSink
extends AbstractSink
implements IRecordListener<DatasourceRecord>

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
AbstractDatasourceSink(GatewayContext context, java.lang.String dataSource)

Method Summary

Modifier and Type	Method	Description
GatewayContext	getContext()
protected Datasource	getDatasource()
java.lang.String	getDatasourceName()
protected abstract java.lang.String	getDescriptionKey()
java.util.List<DataSinkInformation>	getInfo()	Gets the information for this sink, as well as any below it.
protected QueryCache	getQueryCache()
boolean	isAccepting()	Returns whether the data store is accepting data.
void	recordAdded(DatasourceRecord record)
void	recordDeleted(KeyValue key)
void	recordUpdated(DatasourceRecord record)
protected void	runFirstTimeChecks(SRConnection conn)
void	setDatasourceName(java.lang.String dataSource)
void	shutdown()
void	startup()
void	storeData(HistoricalData data)
protected abstract void	storeDataToDatasource(SRConnection conn, HistoricalData data)
protected void	storeToDatasource(Datasource ds, HistoricalData data)
protected void	uninitialize()
protected boolean	useBatching()
protected boolean	useGeneratedKeys()

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

createLogger, getFaultReason, getLogger, getPipelineName, getQuarantineManager, initialize, isFaulted, isInitialized, isStarted, setFaulted, setInitialized, tryToInit

Methods inherited from class java.lang.Object

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

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

getLogName

Methods inherited from interface com.inductiveautomation.ignition.gateway.history.HistoryStorer

acceptsData, isLicensedFor

Constructor Detail

AbstractDatasourceSink

public AbstractDatasourceSink(GatewayContext context,
                              java.lang.String dataSource)

Method Detail

startup

public void startup()

Specified by:

startup in interface DataSink

Overrides:

startup in class AbstractSink

shutdown

public void shutdown()

Specified by:

shutdown in interface DataSink

Overrides:

shutdown in class AbstractSink

recordUpdated

public void recordUpdated(DatasourceRecord record)

Specified by:

recordUpdated in interface IRecordListener<DatasourceRecord>

recordAdded

public void recordAdded(DatasourceRecord record)

Specified by:

recordAdded in interface IRecordListener<DatasourceRecord>

recordDeleted

public void recordDeleted(KeyValue key)

Specified by:

recordDeleted in interface IRecordListener<DatasourceRecord>

getContext

public GatewayContext getContext()

setDatasourceName

public void setDatasourceName(java.lang.String dataSource)

getDatasourceName

public java.lang.String getDatasourceName()

getDatasource

protected Datasource getDatasource()

useBatching

protected boolean useBatching()

useGeneratedKeys

protected boolean useGeneratedKeys()

getQueryCache

protected QueryCache getQueryCache()

getDescriptionKey

protected abstract java.lang.String getDescriptionKey()

getInfo

public java.util.List<DataSinkInformation> getInfo()

Description copied from interface: DataSink

Gets the information for this sink, as well as any below it.

Specified by:

getInfo in interface DataSink

uninitialize

protected void uninitialize()

Overrides:

uninitialize 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 AbstractSink

storeData

public void storeData(HistoricalData data)
               throws java.lang.Exception

Specified by:

storeData in interface HistoryStorer

Throws:

java.lang.Exception

storeToDatasource

protected void storeToDatasource(Datasource ds,
                                 HistoricalData data)
                          throws java.lang.Exception

Throws:

java.lang.Exception

storeDataToDatasource

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

Throws:

java.lang.Exception

runFirstTimeChecks

protected void runFirstTimeChecks(SRConnection conn)
                           throws java.lang.Exception

Throws:

java.lang.Exception