Package com.inductiveautomation.ignition.gateway.storeforward.deprecated

Class BasicScanclassHistorySet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<HistoricalTagValue>

com.inductiveautomation.ignition.gateway.storeforward.deprecated.BasicScanclassHistorySet

All Implemented Interfaces:

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

@Deprecated(since="8.3.0")
public class BasicScanclassHistorySet
extends ArrayList<HistoricalTagValue>
implements ScanclassHistorySet, GroupableData

Deprecated.

See Also:

• Serialized Form

Nested Class Summary

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

RetryHistoricalData.RetryState

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.commons.lang3.tuple.Pair<String,String>	LEGACY_CLASS_PATH	Deprecated.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	add(HistoricalTagValue e)	Deprecated.
protected void	addToCache(HistoricalTagValue htv)	Deprecated.
@Nullable HistoricalData	badData()	Deprecated.
void	clearBadData()	Deprecated.
boolean	contains(Object o)	Deprecated.
BasicScanclassHistorySet	copy()	Deprecated.
Exception	failureReason()	Deprecated.
int	getDataCount()	Deprecated. Retrieves the count of data entries in the historical data.
int	getExecRate()	Deprecated.
Date	getExecutionTime()	Deprecated.
HistoryFlavor	getFlavor()	Deprecated. Retrieves the flavor of the historical data.
String	getGatewayName()	Deprecated.
String	getGroupId()	Deprecated.
String	getLoggerName()	Deprecated. Retrieves the logger name associated with the historical data, if any.
String	getProviderName()	Deprecated.
String	getSetName()	Deprecated.
String	getSignature()	Deprecated. Retrieves the signature of the historical data.
void	markAllAsBad()	Deprecated.
void	markAsBad(HistoricalTagValue value)	Deprecated.
boolean	retryEnabled()	Deprecated.
RetryHistoricalData.RetryState	retryState()	Deprecated.
void	setExecutionTime(Date execTime)	Deprecated.
void	setFailureReason(Exception e)	Deprecated.
void	setRetry(RetryHistoricalData.RetryState state)	Deprecated.
String	toString()	Deprecated.
PersistentDataBundle<?>	upgrade(String engineId)	Deprecated. Attempts to upgrade the historical data to persistent data using the specified engine ID if necessary.

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 com.inductiveautomation.ignition.gateway.storeforward.deprecated.GroupableData

groupData

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

Field Details

LEGACY_CLASS_PATH

public static final org.apache.commons.lang3.tuple.Pair<String,String> LEGACY_CLASS_PATH

Deprecated.

Constructor Details

BasicScanclassHistorySet

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

Deprecated.

BasicScanclassHistorySet

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

Deprecated.

Method Details

copy

public BasicScanclassHistorySet copy()

Deprecated.

getLoggerName

@Nullable
public String getLoggerName()

Deprecated.

Description copied from interface: HistoricalData

Retrieves the logger name associated with the historical data, if any.

Specified by:

getLoggerName in interface HistoricalData

Returns:

the logger name, or null if none is associated

getFlavor

public HistoryFlavor getFlavor()

Deprecated.

Description copied from interface: HistoricalData

Retrieves the flavor of the historical data.

Specified by:

getFlavor in interface HistoricalData

Returns:

the flavor of the historical data

getSignature

public String getSignature()

Deprecated.

Description copied from interface: HistoricalData

Retrieves the signature of the historical data.

Specified by:

getSignature in interface HistoricalData

Returns:

the signature of the historical data

getDataCount

public int getDataCount()

Deprecated.

Description copied from interface: HistoricalData

Retrieves the count of data entries in the historical data.

Specified by:

getDataCount in interface HistoricalData

Returns:

the count of data entries

getExecRate

public int getExecRate()

Deprecated.

Specified by:

getExecRate in interface ScanclassHistorySet

getExecutionTime

public Date getExecutionTime()

Deprecated.

Specified by:

getExecutionTime in interface ScanclassHistorySet

setExecutionTime

public void setExecutionTime(Date execTime)

Deprecated.

getSetName

public String getSetName()

Deprecated.

Specified by:

getSetName in interface ScanclassHistorySet

getProviderName

public String getProviderName()

Deprecated.

Specified by:

getProviderName in interface ScanclassHistorySet

getGatewayName

public String getGatewayName()

Deprecated.

Specified by:

getGatewayName in interface ScanclassHistorySet

markAllAsBad

public void markAllAsBad()

Deprecated.

Specified by:

markAllAsBad in interface RetryHistoricalData

clearBadData

public void clearBadData()

Deprecated.

Specified by:

clearBadData in interface RetryHistoricalData

markAsBad

public void markAsBad(HistoricalTagValue value)

Deprecated.

Specified by:

markAsBad in interface RetryHistoricalData

badData

@Nullable
public @Nullable HistoricalData badData()

Deprecated.

Specified by:

badData in interface RetryHistoricalData

setFailureReason

public void setFailureReason(Exception e)

Deprecated.

Specified by:

setFailureReason in interface RetryHistoricalData

failureReason

public Exception failureReason()

Deprecated.

Specified by:

failureReason in interface RetryHistoricalData

setRetry

public void setRetry(RetryHistoricalData.RetryState state)

Deprecated.

Specified by:

setRetry in interface RetryHistoricalData

retryState

public RetryHistoricalData.RetryState retryState()

Deprecated.

Specified by:

retryState in interface RetryHistoricalData

retryEnabled

public boolean retryEnabled()

Deprecated.

Specified by:

retryEnabled in interface RetryHistoricalData

toString

public String toString()

Deprecated.

Overrides:

toString in class AbstractCollection<HistoricalTagValue>

add

public boolean add(HistoricalTagValue e)

Deprecated.

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)

Deprecated.

contains

public boolean contains(Object o)

Deprecated.

Specified by:

contains in interface Collection<HistoricalTagValue>

Specified by:

contains in interface List<HistoricalTagValue>

Overrides:

contains in class ArrayList<HistoricalTagValue>

getGroupId

public String getGroupId()

Deprecated.

Specified by:

getGroupId in interface GroupableData

upgrade

public PersistentDataBundle<?> upgrade(String engineId)

Deprecated.

Description copied from interface: HistoricalData

Attempts to upgrade the historical data to persistent data using the specified engine ID if necessary.

Specified by:

upgrade in interface GroupableData

Specified by:

upgrade in interface HistoricalData

Parameters:

engineId - the engine ID to use for the upgrade if necessary

Returns:

the upgraded persistent data