Package 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:

GroupableData, HistoricalData, HistoricalDataList, RetryHistoricalData, ScanclassHistorySet, Serializable, Cloneable, Iterable<HistoricalTagValue>, Collection<HistoricalTagValue>, List<HistoricalTagValue>, RandomAccess

public class BasicScanclassHistorySet
extends ArrayList<HistoricalTagValue>
implements ScanclassHistorySet, GroupableData

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.history.RetryHistoricalData

RetryHistoricalData.RetryState

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
BasicScanclassHistorySet(String providerName, String scName, int execRate)
BasicScanclassHistorySet(String gatewayName, String providerName, String scName, int execRate)

Method Summary

Modifier and Type	Method	Description
boolean	add(HistoricalTagValue e)
protected void	addToCache(HistoricalTagValue htv)
HistoricalData	badData()
void	clearBadData()	Removes data flagged as bad
boolean	contains(Object o)
BasicScanclassHistorySet	copy()
Exception	failureReason()
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.
Date	getExecutionTime()
HistoryFlavor	getFlavor()	The very broad "flavor" designator, used to get the data to the correct sink.
String	getGatewayName()	Returns the name of the source gateway.
String	getGroupId()	A string identifing the "group" of the data.
String	getLoggerName()	Returns the name of the logger that should be notified when something happens to this data.
String	getProviderName()	Returns the name of the tag provider that generated this set.
String	getSetName()	The name of the scan class
String	getSignature()	The signature is a static string that describes this data as uniquely as possible.
GroupableData	groupData(GroupableData other)	Merge another piece of similar data into this one.
void	markAllAsBad()	Marks all RetryHistoricalData values as bad
void	markAsBad(HistoricalTagValue value)
boolean	retryEnabled()
RetryHistoricalData.RetryState	retryState()
void	setExecutionTime(Date execTime)
void	setFailureReason(Exception failureReason)
void	setRetry(RetryHistoricalData.RetryState state)
String	toString()

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, clone, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

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

Constructor Details

BasicScanclassHistorySet

public BasicScanclassHistorySet(String providerName,
 String scName,
 int execRate)

BasicScanclassHistorySet

public BasicScanclassHistorySet(String gatewayName,
 String providerName,
 String scName,
 int execRate)

Method Details

copy

public BasicScanclassHistorySet copy()

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

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

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 Date getExecutionTime()

Specified by:

getExecutionTime in interface ScanclassHistorySet

setExecutionTime

public void setExecutionTime(Date execTime)

getSetName

public String getSetName()

Description copied from interface: ScanclassHistorySet

The name of the scan class

Specified by:

getSetName in interface ScanclassHistorySet

getProviderName

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

markAllAsBad

public void markAllAsBad()

Description copied from interface: RetryHistoricalData

Marks all RetryHistoricalData values as bad

Specified by:

markAllAsBad in interface RetryHistoricalData

markAsBad

public void markAsBad(HistoricalTagValue value)

Specified by:

markAsBad in interface RetryHistoricalData

Parameters:

value - HistoricalTagValue that store wasn't able to process

clearBadData

public void clearBadData()

Description copied from interface: RetryHistoricalData

Removes data flagged as bad

Specified by:

clearBadData in interface RetryHistoricalData

badData

@Nullable
public HistoricalData badData()

Specified by:

badData in interface RetryHistoricalData

Returns:

Copy of the HistoricalData containing only data that was marked as bad or null if no data is added

setRetry

public void setRetry(RetryHistoricalData.RetryState state)

Specified by:

setRetry in interface RetryHistoricalData

retryState

public RetryHistoricalData.RetryState retryState()

Specified by:

retryState in interface RetryHistoricalData

retryEnabled

public boolean retryEnabled()

Specified by:

retryEnabled in interface RetryHistoricalData

setFailureReason

public void setFailureReason(@Nullable
 Exception failureReason)

Specified by:

setFailureReason in interface RetryHistoricalData

failureReason

public Exception failureReason()

Specified by:

failureReason in interface RetryHistoricalData

toString

public String toString()

Overrides:

toString in class AbstractCollection<HistoricalTagValue>

add

public boolean add(HistoricalTagValue e)

Specified by:

add in interface Collection<HistoricalTagValue>

Specified by:

add in interface List<HistoricalTagValue>

Overrides:

add in class ArrayList<HistoricalTagValue>

addToCache

protected void addToCache(HistoricalTagValue htv)

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<HistoricalTagValue>

Specified by:

contains in interface List<HistoricalTagValue>

Overrides:

contains in class ArrayList<HistoricalTagValue>

getGroupId

public String getGroupId()

Description copied from interface: GroupableData

A string identifing the "group" of the data. In other words, any piece of data from this group can be merged together.

Specified by:

getGroupId in interface GroupableData

groupData

public GroupableData groupData(GroupableData other)

Description copied from interface: GroupableData

Merge another piece of similar data into this one.

Specified by:

groupData in interface GroupableData