Package com.inductiveautomation.ignition.gateway.storeforward.serialization.util

Class HistorySerializerHelper

java.lang.Object

com.inductiveautomation.ignition.gateway.storeforward.serialization.util.HistorySerializerHelper

public class HistorySerializerHelper
extends Object

Utility class for serializing and deserializing common historical objects.

Method Summary

Modifier and Type	Method	Description
static Annotation	fromAnnotationPB(HistoryDataProto.AnnotationPB annotationPB)	Converts a Protobuf message HistoryDataProto.AnnotationPB representing an Annotation into its corresponding Annotation.
static HistoricalColumn	fromHistoricalColumnPB(HistoricalRecordProto.HistoricalColumnPB columnPB)	Converts a Protobuf message HistoricalRecordProto.HistoricalColumnPB representing a historical column into its corresponding HistoricalColumn.
static PackedHistoricalQualifiedValue	fromHistoricalTagValuePB(HistoryDataProto.HistoricalTagValuePB valPB)	Converts a HistoryDataProto.HistoricalTagValuePB to a PackedHistoricalQualifiedValue.
static HistoryDataProto.HistorySetPB	fromHistorySetToProto(TagGroupHistorySet historySet)	Converts a TagGroupHistorySet to a HistoryDataProto.HistorySetPB.
static HistoryDataProto.HistorySetPB	fromHistorySetToProto(TagGroupHistorySet historySet, @NonNull String defaultSystemName)	Converts a TagGroupHistorySet to a HistoryDataProto.HistorySetPB.
static BasicTagGroupHistorySet	fromProtoToHistorySet(HistoryDataProto.HistorySetPB historySetPB)	Converts a HistoryDataProto.HistorySetPB to a BasicTagGroupHistorySet.
static <T extends BasicHistoricalRecord> String	historicalRecordToJson(T historicalRecord)	Converts a BasicHistoricalRecord to a JSON string.
static <T extends BasicHistoricalRecord> HistoricalRecordProto.BasicHistoricalRecordPB	historicalRecordToProto(T historicalRecord)	Converts a BasicHistoricalRecord to its protobuf representation HistoricalRecordProto.BasicHistoricalRecordPB.
static BasicHistoricalRecord	jsonToHistoricalRecord(String json)	Converts a JSON string to a BasicHistoricalRecord object.
static BasicHistoricalRecord	protoToHistoricalRecord(HistoricalRecordProto.BasicHistoricalRecordPB historicalRecordPB)	Converts a HistoricalRecordProto.BasicHistoricalRecordPB to a BasicHistoricalRecord.
static HistoryDataProto.AnnotationPB	toAnnotationPB(Annotation ann)	Converts an Annotation into its corresponding Protobuf message HistoryDataProto.AnnotationPB.
static HistoricalRecordProto.HistoricalColumnPB	toHistoricalColumnPB(HistoricalColumn column)	Converts a HistoricalColumn into its corresponding Protobuf message HistoricalRecordProto.HistoricalColumnPB.
static HistoryDataProto.HistoricalTagValuePB	toHistoricalTagValuePB(HistoricalTagValue tagValue)	Converts a HistoricalTagValue to a HistoryDataProto.HistoricalTagValuePB.

Methods inherited from class java.lang.Object

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

Method Details

toHistoricalTagValuePB

public static HistoryDataProto.HistoricalTagValuePB toHistoricalTagValuePB(HistoricalTagValue tagValue)

Converts a HistoricalTagValue to a HistoryDataProto.HistoricalTagValuePB.

Parameters:

tagValue - the historical tag value to convert

Returns:

the converted protobuf message

fromHistoricalTagValuePB

public static PackedHistoricalQualifiedValue fromHistoricalTagValuePB(HistoryDataProto.HistoricalTagValuePB valPB)

Converts a HistoryDataProto.HistoricalTagValuePB to a PackedHistoricalQualifiedValue.

Parameters:

valPB - the protobuf message to convert

Returns:

the converted historical tag value

fromHistorySetToProto

public static HistoryDataProto.HistorySetPB fromHistorySetToProto(TagGroupHistorySet historySet)

Converts a TagGroupHistorySet to a HistoryDataProto.HistorySetPB.

Parameters:

historySet - the history set to convert

Returns:

the converted protobuf message

fromHistorySetToProto

public static HistoryDataProto.HistorySetPB fromHistorySetToProto(TagGroupHistorySet historySet,
 @NonNull String defaultSystemName)

Converts a TagGroupHistorySet to a HistoryDataProto.HistorySetPB.

Parameters:

historySet - the history set to convert

defaultSystemName - the default system name to use if the gateway name is null

Returns:

the converted protobuf message

fromProtoToHistorySet

public static BasicTagGroupHistorySet fromProtoToHistorySet(HistoryDataProto.HistorySetPB historySetPB)

Converts a HistoryDataProto.HistorySetPB to a BasicTagGroupHistorySet.

Parameters:

historySetPB - the protobuf message to convert

Returns:

the converted history set

historicalRecordToProto

public static <T extends BasicHistoricalRecord>
HistoricalRecordProto.BasicHistoricalRecordPB historicalRecordToProto(T historicalRecord)

Converts a BasicHistoricalRecord to its protobuf representation HistoricalRecordProto.BasicHistoricalRecordPB.

Parameters:

historicalRecord - the historical record to convert

Returns:

the protobuf representation of the historical record

protoToHistoricalRecord

public static BasicHistoricalRecord protoToHistoricalRecord(HistoricalRecordProto.BasicHistoricalRecordPB historicalRecordPB)

Converts a HistoricalRecordProto.BasicHistoricalRecordPB to a BasicHistoricalRecord.

Parameters:

historicalRecordPB - the protobuf message to convert

Returns:

the converted basic historical record

toHistoricalColumnPB

public static HistoricalRecordProto.HistoricalColumnPB toHistoricalColumnPB(HistoricalColumn column)
                                                                     throws SerializeException

Converts a HistoricalColumn into its corresponding Protobuf message HistoricalRecordProto.HistoricalColumnPB.

Parameters:

column - the historical column to convert

Returns:

the Protobuf message representing the historical column

Throws:

SerializeException - if there is an error during serialization

fromHistoricalColumnPB

public static HistoricalColumn fromHistoricalColumnPB(HistoricalRecordProto.HistoricalColumnPB columnPB)
                                               throws DeserializeException

Converts a Protobuf message HistoricalRecordProto.HistoricalColumnPB representing a historical column into its corresponding HistoricalColumn.

Parameters:

columnPB - the Protobuf message representing the historical column

Returns:

the historical column represented by the Protobuf message

Throws:

DeserializeException - if there is an error during deserialization

historicalRecordToJson

public static <T extends BasicHistoricalRecord>
String historicalRecordToJson(T historicalRecord)
                       throws com.google.protobuf.InvalidProtocolBufferException

Converts a BasicHistoricalRecord to a JSON string.

Parameters:

historicalRecord - the historical record object to convert

Returns:

the JSON string representation of the historical record object

Throws:

com.google.protobuf.InvalidProtocolBufferException

jsonToHistoricalRecord

public static BasicHistoricalRecord jsonToHistoricalRecord(String json)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Converts a JSON string to a BasicHistoricalRecord object.

Parameters:

json - the JSON string to convert

Returns:

the historical record object generated from the JSON string

Throws:

com.google.protobuf.InvalidProtocolBufferException

toAnnotationPB

public static HistoryDataProto.AnnotationPB toAnnotationPB(Annotation ann)

Converts an Annotation into its corresponding Protobuf message HistoryDataProto.AnnotationPB.

Parameters:

ann - the Annotation to convert

Returns:

the Protobuf message representing the Annotation

fromAnnotationPB

public static Annotation fromAnnotationPB(HistoryDataProto.AnnotationPB annotationPB)

Converts a Protobuf message HistoryDataProto.AnnotationPB representing an Annotation into its corresponding Annotation.

Parameters:

annotationPB - the Protobuf message representing the Annotation

Returns:

the Annotation represented by the Protobuf message