Class HistorySerializerHelper
java.lang.Object
com.inductiveautomation.ignition.gateway.storeforward.serialization.util.HistorySerializerHelper
Utility class for serializing and deserializing common historical objects.
-
Method Summary
Modifier and TypeMethodDescriptionstatic AnnotationfromAnnotationPB(HistoryDataProto.AnnotationPB annotationPB) Converts a Protobuf messageHistoryDataProto.AnnotationPBrepresenting an Annotation into its correspondingAnnotation.static HistoricalColumnConverts a Protobuf messageHistoricalRecordProto.HistoricalColumnPBrepresenting a historical column into its correspondingHistoricalColumn.Converts aHistoryDataProto.HistoricalTagValuePBto aPackedHistoricalQualifiedValue.fromHistorySetToProto(TagGroupHistorySet historySet) Converts aTagGroupHistorySetto aHistoryDataProto.HistorySetPB.fromHistorySetToProto(TagGroupHistorySet historySet, @NonNull String defaultSystemName) Converts aTagGroupHistorySetto aHistoryDataProto.HistorySetPB.static BasicTagGroupHistorySetfromProtoToHistorySet(HistoryDataProto.HistorySetPB historySetPB) Converts aHistoryDataProto.HistorySetPBto aBasicTagGroupHistorySet.static <T extends BasicHistoricalRecord>
StringhistoricalRecordToJson(T historicalRecord) Converts aBasicHistoricalRecordto a JSON string.static <T extends BasicHistoricalRecord>
HistoricalRecordProto.BasicHistoricalRecordPBhistoricalRecordToProto(T historicalRecord) Converts aBasicHistoricalRecordto its protobuf representationHistoricalRecordProto.BasicHistoricalRecordPB.static BasicHistoricalRecordjsonToHistoricalRecord(String json) Converts a JSON string to aBasicHistoricalRecordobject.static BasicHistoricalRecordprotoToHistoricalRecord(HistoricalRecordProto.BasicHistoricalRecordPB historicalRecordPB) Converts aHistoricalRecordProto.BasicHistoricalRecordPBto aBasicHistoricalRecord.toAnnotationPB(Annotation ann) Converts anAnnotationinto its corresponding Protobuf messageHistoryDataProto.AnnotationPB.toHistoricalColumnPB(HistoricalColumn column) Converts aHistoricalColumninto its corresponding Protobuf messageHistoricalRecordProto.HistoricalColumnPB.toHistoricalTagValuePB(HistoricalTagValue tagValue) Converts aHistoricalTagValueto aHistoryDataProto.HistoricalTagValuePB.
-
Method Details
-
toHistoricalTagValuePB
public static HistoryDataProto.HistoricalTagValuePB toHistoricalTagValuePB(HistoricalTagValue tagValue) Converts aHistoricalTagValueto aHistoryDataProto.HistoricalTagValuePB.- Parameters:
tagValue- the historical tag value to convert- Returns:
- the converted protobuf message
-
fromHistoricalTagValuePB
public static PackedHistoricalQualifiedValue fromHistoricalTagValuePB(HistoryDataProto.HistoricalTagValuePB valPB) Converts aHistoryDataProto.HistoricalTagValuePBto aPackedHistoricalQualifiedValue.- Parameters:
valPB- the protobuf message to convert- Returns:
- the converted historical tag value
-
fromHistorySetToProto
Converts aTagGroupHistorySetto aHistoryDataProto.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 aTagGroupHistorySetto aHistoryDataProto.HistorySetPB.- Parameters:
historySet- the history set to convertdefaultSystemName- 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 aHistoryDataProto.HistorySetPBto aBasicTagGroupHistorySet.- Parameters:
historySetPB- the protobuf message to convert- Returns:
- the converted history set
-
historicalRecordToProto
public static <T extends BasicHistoricalRecord> HistoricalRecordProto.BasicHistoricalRecordPB historicalRecordToProto(T historicalRecord) Converts aBasicHistoricalRecordto its protobuf representationHistoricalRecordProto.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 aHistoricalRecordProto.BasicHistoricalRecordPBto aBasicHistoricalRecord.- Parameters:
historicalRecordPB- the protobuf message to convert- Returns:
- the converted basic historical record
-
toHistoricalColumnPB
public static HistoricalRecordProto.HistoricalColumnPB toHistoricalColumnPB(HistoricalColumn column) throws SerializeException Converts aHistoricalColumninto its corresponding Protobuf messageHistoricalRecordProto.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 messageHistoricalRecordProto.HistoricalColumnPBrepresenting a historical column into its correspondingHistoricalColumn.- 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 aBasicHistoricalRecordto 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 aBasicHistoricalRecordobject.- Parameters:
json- the JSON string to convert- Returns:
- the historical record object generated from the JSON string
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
toAnnotationPB
Converts anAnnotationinto its corresponding Protobuf messageHistoryDataProto.AnnotationPB.- Parameters:
ann- the Annotation to convert- Returns:
- the Protobuf message representing the Annotation
-
fromAnnotationPB
Converts a Protobuf messageHistoryDataProto.AnnotationPBrepresenting an Annotation into its correspondingAnnotation.- Parameters:
annotationPB- the Protobuf message representing the Annotation- Returns:
- the Annotation represented by the Protobuf message
-