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

Record Class RawQueryKey

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.RawQueryKey
Record Components:
source - The QualifiedPath representing the source of the raw data point.
All Implemented Interfaces:
DataPointQueryKey, QueryKey<DataPointType>
public record RawQueryKey(QualifiedPath source) extends Record implements DataPointQueryKey
Represents a key for querying raw data points.

This record implements DataPointQueryKey and provides a source path for identifying the raw data point being queried. It also specifies the point type as StandardDataPointType.ATOMIC.

  • Constructor Details

    • RawQueryKey

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

  • Method Details

    • pointType

      public DataPointType pointType()
      Retrieves the type of the data point associated with this query key.
      Specified by:
      pointType in interface QueryKey<DataPointType>
      Returns:
      The DataPointType, which is StandardDataPointType.ATOMIC.

    • 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.

    • source

      public QualifiedPath source()
      Returns the value of the source record component.
      Specified by:
      source in interface DataPointQueryKey
      Returns:
      the value of the source record component