Package com.inductiveautomation.ignition.gateway.history

Class PackedHistoricalTagValue

java.lang.Object

com.inductiveautomation.ignition.gateway.history.PackedHistoricalTagValue

All Implemented Interfaces:

HistoricalData, HistoricalTagValue, Serializable

public class PackedHistoricalTagValue
extends Object
implements HistoricalTagValue

An implementation of historical tag value that stores the enums packed together as an integer.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.gateway.history.HistoricalTagValue

TAG_DATA_SIGNITURE

Constructor Summary

Constructors

Constructor	Description
PackedHistoricalTagValue(TagPath path, DataTypeClass typeClass, InterpolationMode queryMode, TimestampSource tsSource, BasicTagValue value)
PackedHistoricalTagValue(TagPath path, DataTypeClass typeClass, InterpolationMode queryMode, TimestampSource tsSource, Object value, DataQuality quality)
PackedHistoricalTagValue(TagPath path, DataTypeClass typeClass, InterpolationMode queryMode, TimestampSource tsSource, Object value, DataQuality quality, Date tstamp)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	This is overridden in a particular way - we don't take value into account! This implementation is relied on to detect multiple values for a given time, which we can't have.
boolean	equals(Object value, boolean includeTimestamp)
int	getDataCount()	This is a fairly ambiguous number, but basically indicates how many rows will ultimately be inserted in the database.
protected int	getField(int field)
HistoryFlavor	getFlavor()	The very broad "flavor" designator, used to get the data to the correct sink.
InterpolationMode	getInterpolationMode()
String	getLoggerName()	Returns the name of the logger that should be notified when something happens to this data.
DataQuality	getQuality()
String	getSignature()	The signature is a static string that describes this data as uniquely as possible.
TagPath	getSource()
Date	getTimestamp()
TimestampSource	getTimestampSource()
DataTypeClass	getTypeClass()
Object	getValue()
int	hashCode()	This hashCode function is implemented according to the same constraints as equals above
protected void	setField(int field, int value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PackedHistoricalTagValue

public PackedHistoricalTagValue(TagPath path,
 DataTypeClass typeClass,
 InterpolationMode queryMode,
 TimestampSource tsSource,
 Object value,
 DataQuality quality)

PackedHistoricalTagValue

public PackedHistoricalTagValue(TagPath path,
 DataTypeClass typeClass,
 InterpolationMode queryMode,
 TimestampSource tsSource,
 Object value,
 DataQuality quality,
 Date tstamp)

PackedHistoricalTagValue

public PackedHistoricalTagValue(TagPath path,
 DataTypeClass typeClass,
 InterpolationMode queryMode,
 TimestampSource tsSource,
 BasicTagValue value)

Method Details

equals

public boolean equals(Object value,
 boolean includeTimestamp)

getQuality

public DataQuality getQuality()

Specified by:

getQuality in interface HistoricalTagValue

getTimestamp

public Date getTimestamp()

Specified by:

getTimestamp in interface HistoricalTagValue

getValue

public Object getValue()

Specified by:

getValue in interface HistoricalTagValue

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

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

getSource

public TagPath getSource()

Specified by:

getSource in interface HistoricalTagValue

getTypeClass

public DataTypeClass getTypeClass()

Specified by:

getTypeClass in interface HistoricalTagValue

getInterpolationMode

public InterpolationMode getInterpolationMode()

Specified by:

getInterpolationMode in interface HistoricalTagValue

getTimestampSource

public TimestampSource getTimestampSource()

Specified by:

getTimestampSource in interface HistoricalTagValue

getField

protected int getField(int field)

setField

protected void setField(int field,
 int value)

equals

public boolean equals(Object obj)

This is overridden in a particular way - we don't take value into account! This implementation is relied on to detect multiple values for a given time, which we can't have. If all other settings are equal, we only look at timestamp.

Overrides:

equals in class Object

hashCode

public int hashCode()

This hashCode function is implemented according to the same constraints as equals above

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object