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

Record Class MetadataQueryKey

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.MetadataQueryKey
Record Components:
identifier - The QualifiedPath representing the unique identifier for the metadata point.
All Implemented Interfaces:
ComplexQueryKey<QualifiedPath>, QueryKey<ComplexPointType>
public record MetadataQueryKey(QualifiedPath identifier) extends Record implements ComplexQueryKey<QualifiedPath>
Represents a key for querying metadata points.

This record implements ComplexQueryKey with a specific identifier type of QualifiedPath. It provides functionality for identifying metadata points and specifies the point type as StandardComplexPointType.METADATA.

  • Constructor Details

    • MetadataQueryKey

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

  • Method Details

    • pointType

      public ComplexPointType pointType()
      Retrieves the type of the complex point associated with this query key.
      Specified by:
      pointType in interface QueryKey<ComplexPointType>
      Returns:
      The ComplexPointType, which is StandardComplexPointType.METADATA.

    • 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