Package com.inductiveautomation.ignition.gateway.history

Class AnnotationHistoricalData

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Annotation>

com.inductiveautomation.ignition.gateway.history.AnnotationHistoricalData

All Implemented Interfaces:

HistoricalData, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Annotation>, java.util.Collection<Annotation>, java.util.List<Annotation>, java.util.RandomAccess

public class AnnotationHistoricalData
extends java.util.ArrayList<Annotation>
implements HistoricalData

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationHistoricalData.AnnotationHistoryFlavor

Field Summary

Fields

Modifier and Type	Field	Description
static HistoryFlavor	FLAVOR

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AnnotationHistoricalData()
AnnotationHistoricalData(java.util.List<Annotation> data)

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

Field Detail

FLAVOR

public static final HistoryFlavor FLAVOR

Constructor Detail

AnnotationHistoricalData

public AnnotationHistoricalData()

AnnotationHistoricalData

public AnnotationHistoricalData(java.util.List<Annotation> data)

Method Detail

getFlavor

public HistoryFlavor getFlavor()

Description copied from interface: HistoricalData

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.

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