Package com.inductiveautomation.ignition.gateway.history

Class TagRetirementList

  • All Implemented Interfaces:
    HistoricalData, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<TagPath>, java.util.Collection<TagPath>, java.util.List<TagPath>, java.util.RandomAccess
    public class TagRetirementList
extends java.util.ArrayList<TagPath>
implements HistoricalData
    This class is used to communicate tag retirement to the data sinks. It is simply a list of retired paths. Each path will be part of the same provider.
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount

    • Constructor Summary

      Constructors 
      Constructor Description
      TagRetirementList​(java.lang.String gwName)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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()
      This returns the standard "SQLTAG" history flavor, so any data sink that stores that type of history should look for this type of data.
      java.lang.String getGatewayName()  
      java.lang.String getLoggerName()
      Returns the name of the logger that should be notified when something happens to this data.
      java.lang.String getSignature()
      The signature is a static string that describes this data as uniquely as possible.

      • Methods inherited from class java.util.ArrayList

        add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

      • Methods inherited from class java.util.AbstractCollection

        containsAll, toString

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, stream, toArray

      • Methods inherited from interface java.util.List

        containsAll

    • Constructor Detail

      • TagRetirementList

        public TagRetirementList​(java.lang.String gwName)

    • Method Detail

      • getGatewayName

        public java.lang.String getGatewayName()

      • getFlavor

        public HistoryFlavor getFlavor()
        This returns the standard "SQLTAG" history flavor, so any data sink that stores that type of history should look for this type of data.
        Specified by:
        getFlavor in interface HistoricalData

      • getSignature

        public java.lang.String getSignature()
        Description copied from interface: HistoricalData
        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).

        Specified by:
        getSignature in interface HistoricalData

      • getDataCount

        public int getDataCount()
        Description copied from interface: HistoricalData
        This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database. Used for judging transaction size.
        Specified by:
        getDataCount in interface HistoricalData

      • getLoggerName

        public java.lang.String getLoggerName()
        Description copied from interface: HistoricalData
        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).
        Specified by:
        getLoggerName in interface HistoricalData