Package com.inductiveautomation.historian.common.model.data

Interface ChangePoint<V>

Type Parameters:
V - The type of the value contained in the change point.
All Superinterfaces:
Comparable<TemporalPoint<V,ChangePointType>>, TemporalPoint<V,ChangePointType>
All Known Implementing Classes:
AnnotationChangePoint, SourceChangePoint
public sealed interface ChangePoint<V> extends TemporalPoint<V,ChangePointType> permits AnnotationChangePoint, SourceChangePoint
Represents a change point in the historian system.

This sealed interface extends TemporalPoint with a value type V and a point type of ChangePointType. It is restricted to the AnnotationChangePoint and SourceChangePoint implementations. It provides methods to retrieve the value, type, and determine if the change point represents a deletion.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isDeletion()
    Determines if the change point represents a deletion.
    default ChangePointType
    type()
    Retrieves the type of the change point.
    V
    value()
    Retrieves the value of the change point.

    Methods inherited from interface com.inductiveautomation.historian.common.model.data.TemporalPoint

    compareTo, source, timestamp

  • Method Details

    • value

      @Nullable V value()
      Retrieves the value of the change point.
      Specified by:
      value in interface TemporalPoint<V,ChangePointType>
      Returns:
      The value of the change point, or null if it represents a deletion.

    • type

      default ChangePointType type()
      Retrieves the type of the change point.

      By default, this method returns StandardChangePointType.GENERIC.

      Specified by:
      type in interface TemporalPoint<V,ChangePointType>
      Returns:
      The type of the change point.

    • isDeletion

      default boolean isDeletion()
      Determines if the change point represents a deletion.

      A change point is considered a deletion if its value is null.

      Returns:
      true if the change point represents a deletion, false otherwise.