Package com.inductiveautomation.historian.common.model.options

Record Class AnnotationQueryKey

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.AnnotationQueryKey
Record Components:
identifier - The QualifiedPath that uniquely identifies the annotation.
All Implemented Interfaces:
ComplexQueryKey<QualifiedPath>, QueryKey<ComplexPointType>
public record AnnotationQueryKey(QualifiedPath identifier) extends Record implements ComplexQueryKey<QualifiedPath>
Represents a query key for annotation data points.

This record encapsulates a QualifiedPath identifier and implements the ComplexQueryKey interface for querying annotation data points.

  • Constructor Details

    • AnnotationQueryKey

      public AnnotationQueryKey(QualifiedPath identifier)
      Creates an instance of a AnnotationQueryKey record class.
      Parameters:
      identifier - the value for the identifier record component

  • Method Details

    • pointType

      public ComplexPointType pointType()
      Retrieves the type of the complex data point.

      This implementation always returns StandardComplexPointType.ANNOTATION.

      Specified by:
      pointType in interface QueryKey<ComplexPointType>
      Returns:
      The ComplexPointType representing the annotation type.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • identifier

      public QualifiedPath identifier()
      Returns the value of the identifier record component.
      Specified by:
      identifier in interface ComplexQueryKey<QualifiedPath>
      Returns:
      the value of the identifier record component