Package com.inductiveautomation.historian.common.rpc.adapters.util

Class HistorianRpcAdapterHelper

java.lang.Object

com.inductiveautomation.historian.common.rpc.adapters.util.HistorianRpcAdapterHelper

public class HistorianRpcAdapterHelper
extends Object

Utility class for converting between common Historian Java objects and their Protocol Buffers representations.

This class provides methods to serialize and deserialize various objects, such as ComplexPointProto.AnnotationPointPB, ComplexPointProto.MetadataPointPB, BasicQualifiedValueProto.BasicQualifiedValuePB, and QualityCodeProto.QualityCodePB. It also handles type-specific conversions and ensures compatibility with Protocol Buffers.

Method Summary

Modifier and Type	Method	Description
static AnnotationPoint	fromAnnotationPB(ComplexPointProto.AnnotationPointPB annotationPB)	Converts a Protocol Buffers representation of an AnnotationPoint into an AnnotationPoint object.
static ComplexPoint<?>	fromComplexPB(ComplexPointProto.ComplexPointPB complexPB)	Converts a Protocol Buffers representation of a ComplexPoint into a ComplexPoint object.
static MetadataPoint	fromMetadataPointPB(ComplexPointProto.MetadataPointPB metadataPB)	Converts a Protocol Buffers representation of a MetadataPoint into a MetadataPoint object.
static Instant	fromProtoMilliToInstant(long epochMilli)	Converts a millisecond epoch value into an Instant.
static TimeRange	fromTimeRangePB(TimeRangeProto.TimeRangePB timeRangePB)	Converts a TimeRangeProto.TimeRangePB Protocol Buffers object into a TimeRange.
static AggregatedQueryKey	toAggregatedQueryKey(DataPointQueryKeysProto.AggregatedQueryKeyPB key)	Converts a Protocol Buffers representation of an AggregatedQueryKey back into an AggregatedQueryKey object.
static DataPointQueryKeysProto.AggregatedQueryKeyPB	toAggregatedQueryKeyPB(AggregatedQueryKey any)	Converts an AggregatedQueryKey object into its Protocol Buffers representation.
static AnnotationQueryKey	toAnnotationKey(ComplexQueryKeysProto.AnnotationQueryKeyPB keyPB)	Converts a Protocol Buffers representation of an AnnotationQueryKey back into an AnnotationQueryKey object.
static ComplexQueryKeysProto.AnnotationQueryKeyPB	toAnnotationKeyPB(AnnotationQueryKey key)	Converts an AnnotationQueryKey object into its Protocol Buffers representation.
static ComplexPointProto.AnnotationPointPB	toAnnotationPB(AnnotationPoint ann)	Converts an AnnotationPoint object into its Protocol Buffers representation.
static BasicQualifiedValue	toBasicQualifiedValue(BasicQualifiedValueProto.BasicQualifiedValuePB valuePB)	Converts a BasicQualifiedValueProto.BasicQualifiedValuePB Protocol Buffers object into a BasicQualifiedValue.
static BasicQualifiedValueProto.BasicQualifiedValuePB	toBasicQualifiedValuePB(QualifiedValue value)	Converts a QualifiedValue object into its BasicQualifiedValueProto.BasicQualifiedValuePB Protocol Buffers representation.
static ComplexPointProto.ComplexPointPB	toComplexPointPB(ComplexPoint<?> cp)	Converts a ComplexPoint object into its Protocol Buffers representation.
static GenericObjectProto.GenericObjectPB	toGenericObjectPB(Object value)	Converts a Java object into its GenericObjectProto.GenericObjectPB Protocol Buffers representation.
static Object	toJavaObject(GenericObjectProto.GenericObjectPB objectPB)	Converts a GenericObjectProto.GenericObjectPB Protocol Buffers object into a Java object.
static MetadataQueryKey	toMetadataKey(ComplexQueryKeysProto.MetadataQueryKeyPB keyPB)	Converts a Protocol Buffers representation of a MetadataQueryKey back into a MetadataQueryKey object.
static ComplexQueryKeysProto.MetadataQueryKeyPB	toMetadataKeyPB(MetadataQueryKey key)	Converts a MetadataQueryKey object into its Protocol Buffers representation.
static ComplexPointProto.MetadataPointPB	toMetadataPointPB(MetadataPoint any)	Converts a MetadataPoint object into its Protocol Buffers representation.
static Map<String,GenericObjectProto.GenericObjectPB>	toPropertiesMap(PropertySet data)	Converts a PropertySet into a map of property names and GenericObjectProto.GenericObjectPB values.
static PropertySet	toPropertySet(Map<String,GenericObjectProto.GenericObjectPB> propertiesMap)	Converts a map of property names and GenericObjectProto.GenericObjectPB values into a PropertySet.
static QualifiedPathProto.QualifiedPathPB	toQualifiedPathPB(QualifiedPath path)	Converts a QualifiedPath object into its QualifiedPathProto.QualifiedPathPB Protocol Buffers representation.
static QualityCode	toQualityCode(QualityCodeProto.QualityCodePB qcPB)	Converts a QualityCodeProto.QualityCodePB Protocol Buffers object into a QualityCode.
static QualityCodeProto.QualityCodePB	toQualityCodePB(QualityCode qc)	Converts a QualityCode object into its QualityCodeProto.QualityCodePB Protocol Buffers representation.
static TimeRangeProto.TimeRangePB	toTimeRangePB(TimeRange timeRange)	Converts a TimeRange object into its Protocol Buffers representation.
static TimeWindow	toTimeWindow(TimeWindowProto.TimeWindowPB windowPB)	Converts a TimeWindowProto.TimeWindowPB Protocol Buffers object into a TimeWindow.
static TimeWindowProto.TimeWindowPB	toTimeWindowPB(TimeWindow window)	Converts a TimeWindow object into its Protocol Buffers representation.

Methods inherited from class java.lang.Object

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

Method Details

toGenericObjectPB

public static GenericObjectProto.GenericObjectPB toGenericObjectPB(@Nullable
 Object value)
                                                            throws ProtoSerializationException

Converts a Java object into its GenericObjectProto.GenericObjectPB Protocol Buffers representation.

Parameters:

value - The Java object to convert. Can be null.

Returns:

A GenericObjectProto.GenericObjectPB representing the given object.

Throws:

ProtoSerializationException - If the object's data type is unsupported.

toJavaObject

public static Object toJavaObject(GenericObjectProto.GenericObjectPB objectPB)
                           throws ProtoSerializationException

Converts a GenericObjectProto.GenericObjectPB Protocol Buffers object into a Java object.

Parameters:

objectPB - The GenericObjectProto.GenericObjectPB to convert.

Returns:

The corresponding Java object, or null if the data type is invalid.

Throws:

ProtoSerializationException - If the data type is unsupported.

toQualifiedPathPB

public static QualifiedPathProto.QualifiedPathPB toQualifiedPathPB(QualifiedPath path)

Converts a QualifiedPath object into its QualifiedPathProto.QualifiedPathPB Protocol Buffers representation.

Parameters:

path - The QualifiedPath to convert.

Returns:

A QualifiedPathProto.QualifiedPathPB representing the given QualifiedPath.

toBasicQualifiedValuePB

public static BasicQualifiedValueProto.BasicQualifiedValuePB toBasicQualifiedValuePB(QualifiedValue value)

Converts a QualifiedValue object into its BasicQualifiedValueProto.BasicQualifiedValuePB Protocol Buffers representation.

Parameters:

value - The QualifiedValue to convert.

Returns:

A BasicQualifiedValueProto.BasicQualifiedValuePB representing the given QualifiedValue.

toQualityCodePB

public static QualityCodeProto.QualityCodePB toQualityCodePB(QualityCode qc)

Converts a QualityCode object into its QualityCodeProto.QualityCodePB Protocol Buffers representation.

Parameters:

qc - The QualityCode to convert.

Returns:

A QualityCodeProto.QualityCodePB representing the given QualityCode.

toBasicQualifiedValue

public static BasicQualifiedValue toBasicQualifiedValue(BasicQualifiedValueProto.BasicQualifiedValuePB valuePB)
                                                 throws ProtoSerializationException

Converts a BasicQualifiedValueProto.BasicQualifiedValuePB Protocol Buffers object into a BasicQualifiedValue.

Parameters:

valuePB - The BasicQualifiedValueProto.BasicQualifiedValuePB to convert.

Returns:

A BasicQualifiedValue created from the given Protocol Buffers object.

Throws:

ProtoSerializationException - If an error occurs during the conversion process.

toQualityCode

public static QualityCode toQualityCode(QualityCodeProto.QualityCodePB qcPB)

Converts a QualityCodeProto.QualityCodePB Protocol Buffers object into a QualityCode.

Parameters:

qcPB - The QualityCodeProto.QualityCodePB to convert.

Returns:

A QualityCode created from the given Protocol Buffers object.

fromAnnotationPB

public static AnnotationPoint fromAnnotationPB(ComplexPointProto.AnnotationPointPB annotationPB)

Converts a Protocol Buffers representation of an AnnotationPoint into an AnnotationPoint object.

Parameters:

annotationPB - The ComplexPointProto.AnnotationPointPB to convert.

Returns:

An AnnotationPoint created from the given Protocol Buffers object.

toAnnotationPB

public static ComplexPointProto.AnnotationPointPB toAnnotationPB(AnnotationPoint ann)

Converts an AnnotationPoint object into its Protocol Buffers representation.

Parameters:

ann - The AnnotationPoint to convert.

Returns:

An ComplexPointProto.AnnotationPointPB representing the given AnnotationPoint.

toMetadataPointPB

public static ComplexPointProto.MetadataPointPB toMetadataPointPB(MetadataPoint any)

Converts a MetadataPoint object into its Protocol Buffers representation.

Parameters:

any - The MetadataPoint to convert.

Returns:

A ComplexPointProto.MetadataPointPB representing the given MetadataPoint.

fromMetadataPointPB

public static MetadataPoint fromMetadataPointPB(ComplexPointProto.MetadataPointPB metadataPB)

Converts a Protocol Buffers representation of a MetadataPoint into a MetadataPoint object.

Parameters:

metadataPB - The ComplexPointProto.MetadataPointPB to convert.

Returns:

A MetadataPoint created from the given Protocol Buffers object.

fromComplexPB

public static ComplexPoint<?> fromComplexPB(ComplexPointProto.ComplexPointPB complexPB)

Converts a Protocol Buffers representation of a ComplexPoint into a ComplexPoint object.

Parameters:

complexPB - The ComplexPointProto.ComplexPointPB to convert.

Returns:

A ComplexPoint created from the given Protocol Buffers object.

Throws:

IllegalArgumentException - If the ComplexPointProto.ComplexPointPB type is unsupported.

toComplexPointPB

public static ComplexPointProto.ComplexPointPB toComplexPointPB(ComplexPoint<?> cp)

Converts a ComplexPoint object into its Protocol Buffers representation.

Parameters:

cp - The ComplexPoint to convert.

Returns:

A ComplexPointProto.ComplexPointPB representing the given ComplexPoint.

Throws:

IllegalArgumentException - If the ComplexPoint type is unsupported.

fromProtoMilliToInstant

@Nullable
public static Instant fromProtoMilliToInstant(long epochMilli)

Converts a millisecond epoch value into an Instant.

If the provided epoch value is negative, this method returns null.

Parameters:

epochMilli - The epoch time in milliseconds.

Returns:

An Instant representing the epoch time, or null if the input is negative.

fromTimeRangePB

public static TimeRange fromTimeRangePB(TimeRangeProto.TimeRangePB timeRangePB)

Converts a TimeRangeProto.TimeRangePB Protocol Buffers object into a TimeRange.

Parameters:

timeRangePB - The TimeRangeProto.TimeRangePB to convert.

Returns:

A TimeRange object created from the given Protocol Buffers object.

toTimeRangePB

public static TimeRangeProto.TimeRangePB toTimeRangePB(TimeRange timeRange)

Converts a TimeRange object into its Protocol Buffers representation.

Parameters:

timeRange - The TimeRange to convert.

Returns:

A TimeRangeProto.TimeRangePB representing the given TimeRange.

toPropertySet

public static PropertySet toPropertySet(Map<String,GenericObjectProto.GenericObjectPB> propertiesMap)

Converts a map of property names and GenericObjectProto.GenericObjectPB values into a PropertySet.

Parameters:

propertiesMap - A map containing property names and their corresponding GenericObjectProto.GenericObjectPB values.

Returns:

A PropertySet created from the given map.

toPropertiesMap

public static Map<String,GenericObjectProto.GenericObjectPB> toPropertiesMap(PropertySet data)

Converts a PropertySet into a map of property names and GenericObjectProto.GenericObjectPB values.

Parameters:

data - The PropertySet to convert.

Returns:

A map containing property names and their corresponding GenericObjectProto.GenericObjectPB values.

toTimeWindowPB

public static TimeWindowProto.TimeWindowPB toTimeWindowPB(TimeWindow window)

Converts a TimeWindow object into its Protocol Buffers representation.

Parameters:

window - The TimeWindow to convert.

Returns:

A TimeWindowProto.TimeWindowPB representing the given TimeWindow.

toTimeWindow

public static TimeWindow toTimeWindow(TimeWindowProto.TimeWindowPB windowPB)

Converts a TimeWindowProto.TimeWindowPB Protocol Buffers object into a TimeWindow.

Parameters:

windowPB - The TimeWindowProto.TimeWindowPB to convert.

Returns:

A TimeWindow created from the given Protocol Buffers object.

toMetadataKeyPB

public static ComplexQueryKeysProto.MetadataQueryKeyPB toMetadataKeyPB(MetadataQueryKey key)

Converts a MetadataQueryKey object into its Protocol Buffers representation.

Parameters:

key - The MetadataQueryKey to convert.

Returns:

A ComplexQueryKeysProto.MetadataQueryKeyPB representing the given MetadataQueryKey.

toMetadataKey

public static MetadataQueryKey toMetadataKey(ComplexQueryKeysProto.MetadataQueryKeyPB keyPB)

Converts a Protocol Buffers representation of a MetadataQueryKey back into a MetadataQueryKey object.

Parameters:

keyPB - The ComplexQueryKeysProto.MetadataQueryKeyPB to convert.

Returns:

A MetadataQueryKey created from the given ComplexQueryKeysProto.MetadataQueryKeyPB.

toAnnotationKey

public static AnnotationQueryKey toAnnotationKey(ComplexQueryKeysProto.AnnotationQueryKeyPB keyPB)

Converts a Protocol Buffers representation of an AnnotationQueryKey back into an AnnotationQueryKey object.

Parameters:

keyPB - The ComplexQueryKeysProto.AnnotationQueryKeyPB to convert.

Returns:

An AnnotationQueryKey created from the given Protocol Buffers object.

toAnnotationKeyPB

public static ComplexQueryKeysProto.AnnotationQueryKeyPB toAnnotationKeyPB(AnnotationQueryKey key)

Converts an AnnotationQueryKey object into its Protocol Buffers representation.

Parameters:

key - The AnnotationQueryKey to convert.

Returns:

A ComplexQueryKeysProto.AnnotationQueryKeyPB representing the given AnnotationQueryKey.

toAggregatedQueryKeyPB

public static DataPointQueryKeysProto.AggregatedQueryKeyPB toAggregatedQueryKeyPB(AggregatedQueryKey any)

Converts an AggregatedQueryKey object into its Protocol Buffers representation.

Parameters:

any - The AggregatedQueryKey to convert.

Returns:

A DataPointQueryKeysProto.AggregatedQueryKeyPB representing the given AggregatedQueryKey.

toAggregatedQueryKey

public static AggregatedQueryKey toAggregatedQueryKey(DataPointQueryKeysProto.AggregatedQueryKeyPB key)
                                               throws IOException

Converts a Protocol Buffers representation of an AggregatedQueryKey back into an AggregatedQueryKey object.

Parameters:

key - The DataPointQueryKeysProto.AggregatedQueryKeyPB to convert.

Returns:

An AggregatedQueryKey created from the given Protocol Buffers object.

Throws:

IOException - If an error occurs during the conversion process.