com.inductiveautomation.ignition.gateway.sqltags.model

Class BasicScanclassHistorySet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<HistoricalTagValue>

com.inductiveautomation.ignition.gateway.sqltags.model.BasicScanclassHistorySet

All Implemented Interfaces:

HistoricalData, HistoricalDataList, ScanclassHistorySet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<HistoricalTagValue>, java.util.Collection<HistoricalTagValue>, java.util.List<HistoricalTagValue>, java.util.RandomAccess

public class BasicScanclassHistorySet
extends java.util.ArrayList<HistoricalTagValue>
implements ScanclassHistorySet

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
BasicScanclassHistorySet(java.lang.String providerName, java.lang.String scName, int execRate)
BasicScanclassHistorySet(java.lang.String gatewayName, java.lang.String providerName, java.lang.String scName, int execRate)

Method Summary

Modifier and Type	Method and Description
boolean	add(HistoricalTagValue e)
protected void	addToCache(HistoricalTagValue htv)
boolean	contains(java.lang.Object o)
int	getDataCount() This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database.
int	getExecRate() The rate that the scan class is executing at.
java.util.Date	getExecutionTime()
HistoryFlavor	getFlavor() The very broad "flavor" designator, used to get the data to the correct sink.
java.lang.String	getGatewayName() Returns the name of the source gateway.
java.lang.String	getLoggerName() Returns the name of the logger that should be notified when something happens to this data.
java.lang.String	getProviderName() Returns the name of the tag provider that generated this set.
java.lang.String	getSetName() The name of the scan class
java.lang.String	getSignature() The signature is a static string that describes this data as uniquely as possible.
void	setExecutionTime(java.util.Date execTime)
java.lang.String	toString()

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, clone, ensureCapacity, forEach, get, 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.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

add, addAll, addAll, clear, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BasicScanclassHistorySet

public BasicScanclassHistorySet(java.lang.String providerName,
                                java.lang.String scName,
                                int execRate)

BasicScanclassHistorySet

public BasicScanclassHistorySet(java.lang.String gatewayName,
                                java.lang.String providerName,
                                java.lang.String scName,
                                int execRate)

Method Detail

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

Returns:

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

Returns:

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

Returns:

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

Returns:

getExecRate

public int getExecRate()

Description copied from interface: ScanclassHistorySet

The rate that the scan class is executing at. Returns 0 to indicate a non-direct scan class (one that doesn't execute regularly)

Specified by:

getExecRate in interface ScanclassHistorySet

getExecutionTime

public java.util.Date getExecutionTime()

Specified by:

getExecutionTime in interface ScanclassHistorySet

setExecutionTime

public void setExecutionTime(java.util.Date execTime)

getSetName

public java.lang.String getSetName()

Description copied from interface: ScanclassHistorySet

The name of the scan class

Specified by:

getSetName in interface ScanclassHistorySet

getProviderName

public java.lang.String getProviderName()

Description copied from interface: ScanclassHistorySet

Returns the name of the tag provider that generated this set.

Specified by:

getProviderName in interface ScanclassHistorySet

getGatewayName

public java.lang.String getGatewayName()

Description copied from interface: ScanclassHistorySet

Returns the name of the source gateway. If null, it is the local gateway.

Specified by:

getGatewayName in interface ScanclassHistorySet

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<HistoricalTagValue>

add

public boolean add(HistoricalTagValue e)

Specified by:

add in interface java.util.Collection<HistoricalTagValue>

Specified by:

add in interface java.util.List<HistoricalTagValue>

Overrides:

add in class java.util.ArrayList<HistoricalTagValue>

addToCache

protected void addToCache(HistoricalTagValue htv)

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<HistoricalTagValue>

Specified by:

contains in interface java.util.List<HistoricalTagValue>

Overrides:

contains in class java.util.ArrayList<HistoricalTagValue>