Package com.inductiveautomation.ignition.gateway.history

Interface HistoricalData

All Superinterfaces:
Serializable
All Known Subinterfaces:
CacheOptimizedData, DatasourceData, DataTransaction, GroupableData, HistoricalDataList, HistoricalTagValue, RetryHistoricalData, ScanclassHistorySet
All Known Implementing Classes:
AnnotationHistoricalData, BasicDataTransaction, BasicHistoricalRecord, BasicHistoricalTagValue, BasicScanclassHistorySet, PackedHistoricalQualifiedValue, PackedHistoricalTagValue, TagRetirementList
public interface HistoricalData extends Serializable
Marker interface indicating this object is intended to be stored historically.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDataCount()
    This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database.
    HistoryFlavor
    getFlavor()
    The very broad "flavor" designator, used to get the data to the correct sink.
    String
    getLoggerName()
    Returns the name of the logger that should be notified when something happens to this data.
    String
    getSignature()
    The signature is a static string that describes this data as uniquely as possible.

  • Method Details

    • getFlavor

      HistoryFlavor getFlavor()
      The very broad "flavor" designator, used to get the data to the correct sink. That is, different sinks support different types of data, and this is used to match them up.

    • getSignature

      String getSignature()
      The signature is a static string that describes this data as uniquely as possible. This will be used to group data in the data cache (for example, when displaying quarantined data), as well as uniquely identifying cacheable schemas, etc.

      Basically, the golden rule is that if two pieces of data have the same signature, the came from the same place, and are going to the same place, and in theory could be grouped together (note: they won't be, that is done with the GroupableData interface).

    • getDataCount

      int getDataCount()
      This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database. Used for judging transaction size.

    • getLoggerName

      String getLoggerName()
      Returns the name of the logger that should be notified when something happens to this data. If null or empty, notifications won't occur (errors, however, may still be logged to the general logger).