com.inductiveautomation.ignition.gateway.history

Class HistoryFlavor

java.lang.Object

com.inductiveautomation.ignition.gateway.history.HistoryFlavor

Direct Known Subclasses:

BasicHistoricalRecord.HistoricalRecordFlavor, TagHistoryFlavor

public class HistoryFlavor
extends java.lang.Object

The HistoryFlavor is used to distinguish different types of historical data. Different data sinks will specialize in handling different flavors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HistoryFlavor.Base64XMLReader

Field Summary

Fields

Modifier and Type	Field and Description
static HistoryFlavor	SQLTAG

Constructor Summary

Constructors

Constructor and Description
HistoryFlavor(java.lang.String uid)
HistoryFlavor(java.lang.String uid, java.lang.String subId, java.lang.String descKey)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equals(java.lang.Object obj, boolean includeSubtype)
LocalizedString	getDescription()
SimpleXMLReader<HistoricalData>	getXMLImportHandler(GatewayContext context) Gets the XML reader that can decode the output from writeToXML.
boolean	isCompatible(HistoryFlavor flavor) Kind of like equals, tells whether the incoming flavor is compatible with this one.
java.lang.String	subTypeId() This id is used as a finer grained identifying under the root flavor id.
java.lang.String	toString()
java.lang.String	typeId() This is the broad type id.
void	writeToXML(SimpleXMLWriter writer, HistoricalData data)

Methods inherited from class java.lang.Object

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

Field Detail

SQLTAG

public static final HistoryFlavor SQLTAG

Constructor Detail

HistoryFlavor

public HistoryFlavor(java.lang.String uid)

HistoryFlavor

public HistoryFlavor(java.lang.String uid,
                     java.lang.String subId,
                     java.lang.String descKey)

Method Detail

typeId

public java.lang.String typeId()

This is the broad type id. Different datasinks will look at this to decide if they support the data.

Returns:

subTypeId

public java.lang.String subTypeId()

This id is used as a finer grained identifying under the root flavor id. This will be used to find the correct codec for this type of data. For example, DatasourceData is a generic flavor for things that store to a connection. However, that is not enough information to support import/export, so implementors can register codecs for subtypes, and use those flavors, while still being "DatasourceData".

Returns:

getDescription

public LocalizedString getDescription()

isCompatible

public boolean isCompatible(HistoryFlavor flavor)

Kind of like equals, tells whether the incoming flavor is compatible with this one. Necessary because some subclass flavors can encompass other flavors. Base implementation just uses equals.

Parameters:

flavor -

writeToXML

public void writeToXML(SimpleXMLWriter writer,
                       HistoricalData data)
                throws java.lang.Exception

Throws:

java.lang.Exception

getXMLImportHandler

public SimpleXMLReader<HistoricalData> getXMLImportHandler(GatewayContext context)

Gets the XML reader that can decode the output from writeToXML. The default implementation reads from base64. It is provided with the gateway context in case any special deserialization needs to occur.

Parameters:

context -

Returns:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(java.lang.Object obj,
                      boolean includeSubtype)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object