Class HistorianSink
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractSink
-
- com.inductiveautomation.gateway.tags.history.tsdb.HistorianSink
-
- All Implemented Interfaces:
DataSink
,HistoryStorer
public class HistorianSink extends AbstractSink
Created by Colby.Clegg on 2/5/2016.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
HistorianSink.HistoryTagValueTSComparator
protected class
HistorianSink.TagDetails
-
Field Summary
Fields Modifier and Type Field Description protected static java.util.Comparator<HistoricalTagValue>
HTV_COMP
-
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 HistorianSink(GatewayContext context, java.lang.String name, Historian historian)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptsData(HistoryFlavor dataType)
Returns whether or not the storer can accept the specified type of data.java.util.List<DataSinkInformation>
getInfo()
Gets the information for this sink, as well as any below it.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 void
registerTags(java.util.List<HistorianSink.TagDetails> details)
void
setLicenseProvider(java.util.function.Supplier<java.lang.Boolean> licenseSupplier)
void
storeData(HistoricalData data)
-
Methods inherited from class com.inductiveautomation.ignition.gateway.history.sf.sinks.AbstractSink
createLogger, getFaultReason, getLogger, getPipelineName, getQuarantineManager, initialize, isAccepting, isFaulted, isInitialized, isStarted, setFaulted, setInitialized, shutdown, startup, tryToInit, uninitialize
-
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
-
-
-
-
Field Detail
-
HTV_COMP
protected static final java.util.Comparator<HistoricalTagValue> HTV_COMP
-
-
Constructor Detail
-
HistorianSink
public HistorianSink(GatewayContext context, java.lang.String name, Historian historian)
-
-
Method Detail
-
setLicenseProvider
public void setLicenseProvider(java.util.function.Supplier<java.lang.Boolean> licenseSupplier)
-
getInfo
public java.util.List<DataSinkInformation> getInfo()
Description copied from interface:DataSink
Gets the information for this sink, as well as any below it.
-
acceptsData
public boolean acceptsData(HistoryFlavor dataType)
Description copied from interface:HistoryStorer
Returns whether or not the storer can accept the specified type of data.
-
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.
-
storeData
public void storeData(HistoricalData data) throws java.lang.Exception
- Throws:
java.lang.Exception
-
registerTags
protected void registerTags(java.util.List<HistorianSink.TagDetails> details)
-
-