Package com.inductiveautomation.ignition.gateway.history

Class TagRetirementList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<TagPath>

com.inductiveautomation.ignition.gateway.history.TagRetirementList

All Implemented Interfaces:

HistoricalData, Serializable, Cloneable, Iterable<TagPath>, Collection<TagPath>, List<TagPath>, RandomAccess

public class TagRetirementList
extends 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(String gwName)

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()	This returns the standard "SQLTAG" history flavor, so any data sink that stores that type of history should look for this type of data.
String	getGatewayName()
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.

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 Details

TagRetirementList

public TagRetirementList(String gwName)

Method Details

getGatewayName

public 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 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 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