com.aquenos.cassandra.pvarchiver.controlsystem.util

Class JsonV1SampleSerializer

java.lang.Object

com.aquenos.cassandra.pvarchiver.controlsystem.util.JsonV1SampleSerializer

public abstract class JsonV1SampleSerializer
extends Object

Utility for serializing samples in the JSON format version 1. This utility should be used by implementations of ControlSystemSupport.serializeSampleToJsonV1(com.aquenos.cassandra.pvarchiver.controlsystem.Sample, JsonGenerator) in order to ensure that the serialized form matches the expected format.

Author:

Sebastian Marsching

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonV1SampleSerializer.Quality Sample quality.
static class	JsonV1SampleSerializer.Severity Alarm severity associated with a sample.

Method Summary

Modifier and Type	Method and Description
static void	serializeDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes an array double sample without additional meta-data.
static void	serializeDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, int precision, String units, double displayLow, double displayHigh, double warnLow, double warnHigh, double alarmLow, double alarmHigh) Serializes an array double sample with additional meta-data.
static void	serializeDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes a scalar double sample without additional meta-data.
static void	serializeDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, int precision, String units, double displayLow, double displayHigh, double warnLow, double warnHigh, double alarmLow, double alarmHigh) Serializes a scalar double sample with additional meta-data.
static void	serializeEnumSample(JsonGenerator jsonGenerator, long timeStamp, int[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes an array enum sample without additional meta-data.
static void	serializeEnumSample(JsonGenerator jsonGenerator, long timeStamp, int[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, String[] states) Serializes an array enum sample without additional meta-data.
static void	serializeEnumSample(JsonGenerator jsonGenerator, long timeStamp, int value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes a scalar enum sample without additional meta-data.
static void	serializeEnumSample(JsonGenerator jsonGenerator, long timeStamp, int value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, String[] states) Serializes a scalar enum sample with additional meta-data.
static void	serializeLongSample(JsonGenerator jsonGenerator, long timeStamp, long[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes an array long sample without additional meta-data.
static void	serializeLongSample(JsonGenerator jsonGenerator, long timeStamp, long[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, int precision, String units, double displayLow, double displayHigh, double warnLow, double warnHigh, double alarmLow, double alarmHigh) Serializes an array long sample with additional meta-data.
static void	serializeLongSample(JsonGenerator jsonGenerator, long timeStamp, long value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes a scalar long sample without additional meta-data.
static void	serializeLongSample(JsonGenerator jsonGenerator, long timeStamp, long value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, int precision, String units, double displayLow, double displayHigh, double warnLow, double warnHigh, double alarmLow, double alarmHigh) Serializes a scalar long sample with additional meta-data.
static void	serializeMinMaxDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double[] value, double minimum, double maximum, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes an array min-max double sample without additional meta-data.
static void	serializeMinMaxDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double[] value, double minimum, double maximum, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, int precision, String units, double displayLow, double displayHigh, double warnLow, double warnHigh, double alarmLow, double alarmHigh) Serializes an array min-max double sample with additional meta-data.
static void	serializeMinMaxDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double value, double minimum, double maximum, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes a scalar min-max double sample without additional meta-data.
static void	serializeMinMaxDoubleSample(JsonGenerator jsonGenerator, long timeStamp, double value, double minimum, double maximum, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality, int precision, String units, double displayLow, double displayHigh, double warnLow, double warnHigh, double alarmLow, double alarmHigh) Serializes a scalar min-max double sample with additional meta-data.
static void	serializeStringSample(JsonGenerator jsonGenerator, long timeStamp, String[] value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes an array string sample.
static void	serializeStringSample(JsonGenerator jsonGenerator, long timeStamp, String value, JsonV1SampleSerializer.Severity severity, boolean hasValue, String status, JsonV1SampleSerializer.Quality quality) Serializes a scalar (single element) string sample.

Methods inherited from class java.lang.Object

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

Method Detail

serializeDoubleSample

public static void serializeDoubleSample(JsonGenerator jsonGenerator,
                                         long timeStamp,
                                         double value,
                                         JsonV1SampleSerializer.Severity severity,
                                         boolean hasValue,
                                         String status,
                                         JsonV1SampleSerializer.Quality quality)
                                  throws IOException

Serializes a scalar double sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeDoubleSample

public static void serializeDoubleSample(JsonGenerator jsonGenerator,
                                         long timeStamp,
                                         double value,
                                         JsonV1SampleSerializer.Severity severity,
                                         boolean hasValue,
                                         String status,
                                         JsonV1SampleSerializer.Quality quality,
                                         int precision,
                                         String units,
                                         double displayLow,
                                         double displayHigh,
                                         double warnLow,
                                         double warnHigh,
                                         double alarmLow,
                                         double alarmHigh)
                                  throws IOException

Serializes a scalar double sample with additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

precision - display precision of the sample's value. The precision specifies the number of fractional digits that should be displayed.

units - engineering units of the sample's value.

displayLow - lower display limit for the sample's value.

displayHigh - upper display limit for the sample's value.

warnLow - lower warning limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a minor alarm condition.

warnHigh - upper warning limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a minor alarm condition.

alarmLow - lower alarm limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a major alarm condition.

alarmHigh - upper alarm limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a major alarm condition.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeDoubleSample

public static void serializeDoubleSample(JsonGenerator jsonGenerator,
                                         long timeStamp,
                                         double[] value,
                                         JsonV1SampleSerializer.Severity severity,
                                         boolean hasValue,
                                         String status,
                                         JsonV1SampleSerializer.Quality quality)
                                  throws IOException

Serializes an array double sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeDoubleSample

public static void serializeDoubleSample(JsonGenerator jsonGenerator,
                                         long timeStamp,
                                         double[] value,
                                         JsonV1SampleSerializer.Severity severity,
                                         boolean hasValue,
                                         String status,
                                         JsonV1SampleSerializer.Quality quality,
                                         int precision,
                                         String units,
                                         double displayLow,
                                         double displayHigh,
                                         double warnLow,
                                         double warnHigh,
                                         double alarmLow,
                                         double alarmHigh)
                                  throws IOException

Serializes an array double sample with additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

precision - display precision of the sample's value. The precision specifies the number of fractional digits that should be displayed.

units - engineering units of the sample's value.

displayLow - lower display limit for the sample's value.

displayHigh - upper display limit for the sample's value.

warnLow - lower warning limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a minor alarm condition.

warnHigh - upper warning limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a minor alarm condition.

alarmLow - lower alarm limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a major alarm condition.

alarmHigh - upper alarm limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a major alarm condition.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeEnumSample

public static void serializeEnumSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       int value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality)
                                throws IOException

Serializes a scalar enum sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeEnumSample

public static void serializeEnumSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       int value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality,
                                       String[] states)
                                throws IOException

Serializes a scalar enum sample with additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

states - labels associated with the enum states. The specified value serves as an index into this array.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeEnumSample

public static void serializeEnumSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       int[] value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality)
                                throws IOException

Serializes an array enum sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeEnumSample

public static void serializeEnumSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       int[] value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality,
                                       String[] states)
                                throws IOException

Serializes an array enum sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

states - labels associated with the enum states. The specified value serves as an index into this array.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeLongSample

public static void serializeLongSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       long value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality)
                                throws IOException

Serializes a scalar long sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeLongSample

public static void serializeLongSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       long value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality,
                                       int precision,
                                       String units,
                                       double displayLow,
                                       double displayHigh,
                                       double warnLow,
                                       double warnHigh,
                                       double alarmLow,
                                       double alarmHigh)
                                throws IOException

Serializes a scalar long sample with additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

precision - display precision of the sample's value. The precision specifies the number of fractional digits that should be displayed.

units - engineering units of the sample's value.

displayLow - lower display limit for the sample's value.

displayHigh - upper display limit for the sample's value.

warnLow - lower warning limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a minor alarm condition.

warnHigh - upper warning limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a minor alarm condition.

alarmLow - lower alarm limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a major alarm condition.

alarmHigh - upper alarm limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a major alarm condition.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeLongSample

public static void serializeLongSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       long[] value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality)
                                throws IOException

Serializes an array long sample without additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeLongSample

public static void serializeLongSample(JsonGenerator jsonGenerator,
                                       long timeStamp,
                                       long[] value,
                                       JsonV1SampleSerializer.Severity severity,
                                       boolean hasValue,
                                       String status,
                                       JsonV1SampleSerializer.Quality quality,
                                       int precision,
                                       String units,
                                       double displayLow,
                                       double displayHigh,
                                       double warnLow,
                                       double warnHigh,
                                       double alarmLow,
                                       double alarmHigh)
                                throws IOException

Serializes an array long sample with additional meta-data.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

precision - display precision of the sample's value. The precision specifies the number of fractional digits that should be displayed.

units - engineering units of the sample's value.

displayLow - lower display limit for the sample's value.

displayHigh - upper display limit for the sample's value.

warnLow - lower warning limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a minor alarm condition.

warnHigh - upper warning limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a minor alarm condition.

alarmLow - lower alarm limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a major alarm condition.

alarmHigh - upper alarm limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a major alarm condition.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeMinMaxDoubleSample

public static void serializeMinMaxDoubleSample(JsonGenerator jsonGenerator,
                                               long timeStamp,
                                               double value,
                                               double minimum,
                                               double maximum,
                                               JsonV1SampleSerializer.Severity severity,
                                               boolean hasValue,
                                               String status,
                                               JsonV1SampleSerializer.Quality quality)
                                        throws IOException

Serializes a scalar min-max double sample without additional meta-data. Typically, a min-max double sample is used for interpolated samples. For such a sample, the value is the mean of the aggregated samples' values and minimum and maximum specify the interval which contains all of the aggregated samples' values.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. For an interpolated sample, this typically is the mean of the aggregated samples' values.

minimum - minimum value. For an interpolated sample, this is typically the smallest value that any of the aggregated samples had.

maximum - maximum value. For an interpolated sample, this is typically the largest value that any of the aggregated samples had.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeMinMaxDoubleSample

public static void serializeMinMaxDoubleSample(JsonGenerator jsonGenerator,
                                               long timeStamp,
                                               double value,
                                               double minimum,
                                               double maximum,
                                               JsonV1SampleSerializer.Severity severity,
                                               boolean hasValue,
                                               String status,
                                               JsonV1SampleSerializer.Quality quality,
                                               int precision,
                                               String units,
                                               double displayLow,
                                               double displayHigh,
                                               double warnLow,
                                               double warnHigh,
                                               double alarmLow,
                                               double alarmHigh)
                                        throws IOException

Serializes a scalar min-max double sample with additional meta-data. Typically, a min-max double sample is used for interpolated samples. For such a sample, the value is the mean of the aggregated samples' values and minimum and maximum specify the interval which contains all of the aggregated samples' values.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. For an interpolated sample, this typically is the mean of the aggregated samples' values.

minimum - minimum value. For an interpolated sample, this is typically the smallest value that any of the aggregated samples had.

maximum - maximum value. For an interpolated sample, this is typically the largest value that any of the aggregated samples had.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

precision - display precision of the sample's value. The precision specifies the number of fractional digits that should be displayed.

units - engineering units of the sample's value.

displayLow - lower display limit for the sample's value.

displayHigh - upper display limit for the sample's value.

warnLow - lower warning limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a minor alarm condition.

warnHigh - upper warning limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a minor alarm condition.

alarmLow - lower alarm limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a major alarm condition.

alarmHigh - upper alarm limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a major alarm condition.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeMinMaxDoubleSample

public static void serializeMinMaxDoubleSample(JsonGenerator jsonGenerator,
                                               long timeStamp,
                                               double[] value,
                                               double minimum,
                                               double maximum,
                                               JsonV1SampleSerializer.Severity severity,
                                               boolean hasValue,
                                               String status,
                                               JsonV1SampleSerializer.Quality quality)
                                        throws IOException

Serializes an array min-max double sample without additional meta-data. Typically, a min-max double sample is used for interpolated samples. For such a sample, the value is the mean of the aggregated samples' values and minimum and maximum specify the interval which contains all of the aggregated samples' values.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements. For an interpolated sample, this typically is the (element-wise) mean of the aggregated samples' values.

minimum - minimum value. For an interpolated sample, this is typically the smallest value that any of the aggregated samples had.

maximum - maximum value. For an interpolated sample, this is typically the largest value that any of the aggregated samples had.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeMinMaxDoubleSample

public static void serializeMinMaxDoubleSample(JsonGenerator jsonGenerator,
                                               long timeStamp,
                                               double[] value,
                                               double minimum,
                                               double maximum,
                                               JsonV1SampleSerializer.Severity severity,
                                               boolean hasValue,
                                               String status,
                                               JsonV1SampleSerializer.Quality quality,
                                               int precision,
                                               String units,
                                               double displayLow,
                                               double displayHigh,
                                               double warnLow,
                                               double warnHigh,
                                               double alarmLow,
                                               double alarmHigh)
                                        throws IOException

Serializes an array min-max double sample with additional meta-data. Typically, a min-max double sample is used for interpolated samples. For such a sample, the value is the mean of the aggregated samples' values and minimum and maximum specify the interval which contains all of the aggregated samples' values.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements. For an interpolated sample, this typically is the (element-wise) mean of the aggregated samples' values.

minimum - minimum value. For an interpolated sample, this is typically the smallest value that any of the aggregated samples had.

maximum - maximum value. For an interpolated sample, this is typically the largest value that any of the aggregated samples had.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

precision - display precision of the sample's value. The precision specifies the number of fractional digits that should be displayed.

units - engineering units of the sample's value.

displayLow - lower display limit for the sample's value.

displayHigh - upper display limit for the sample's value.

warnLow - lower warning limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a minor alarm condition.

warnHigh - upper warning limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a minor alarm condition.

alarmLow - lower alarm limit for the sample's value. Typically, this is the limit below which the process variable is considered to be in a major alarm condition.

alarmHigh - upper alarm limit for the sample's value. Typically, this is the limit above which the process variable is considered to be in a major alarm condition.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeStringSample

public static void serializeStringSample(JsonGenerator jsonGenerator,
                                         long timeStamp,
                                         String value,
                                         JsonV1SampleSerializer.Severity severity,
                                         boolean hasValue,
                                         String status,
                                         JsonV1SampleSerializer.Quality quality)
                                  throws IOException

Serializes a scalar (single element) string sample.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.

serializeStringSample

public static void serializeStringSample(JsonGenerator jsonGenerator,
                                         long timeStamp,
                                         String[] value,
                                         JsonV1SampleSerializer.Severity severity,
                                         boolean hasValue,
                                         String status,
                                         JsonV1SampleSerializer.Quality quality)
                                  throws IOException

Serializes an array string sample.

Parameters:

jsonGenerator - JSON generator to which the serialized data is written.

timeStamp - time stamp of the sample. The time stamp is specified in nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

value - actual value of the sample. The array may contain zero, one, or more elements.

severity - alarm severity associated with the sample.

hasValue - true if the sample has a (valid) value, false if the value should be ignored (possibly because it is invalid).

status - status of the sample. Typically, this string contains additional information about the alarm conditions that were present when the sample was archived.

quality - quality of the sample. The quality specifies whether the sample was retrieved directly from the control-system or whether it was calculated by aggregating the samples for a certain period of time.

Throws:

IOException - if the jsonGenerator throws such an exception.