Record Class Row.Calculation

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.Row.Calculation
All Implemented Interfaces:
Row
Enclosing interface:
Row

public static record Row.Calculation(long timestamp, QualifiedPath path, AggregateId aggregate, Object value, QualityCode quality) extends Record implements Row
Calculation row: one aggregate result per row, with the timestamp of the start of the window it finalized over. DatasetSink writes it as the first column of the CALCULATION dataset.
  • Constructor Details

    • Calculation

      public Calculation(long timestamp, QualifiedPath path, AggregateId aggregate, Object value, QualityCode quality)
      Creates an instance of a Calculation record class.
      Parameters:
      timestamp - the value for the timestamp record component
      path - the value for the path record component
      aggregate - the value for the aggregate record component
      value - the value for the value record component
      quality - the value for the quality record component
  • Method Details

    • qualities

      public QualityCode[] qualities()
      Description copied from interface: Row
      Returns the per-cell qualities; never null or empty.
      Specified by:
      qualities in interface Row
    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface Row
      Returns:
      the value of the timestamp record component
    • path

      public QualifiedPath path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component
    • aggregate

      public AggregateId aggregate()
      Returns the value of the aggregate record component.
      Returns:
      the value of the aggregate record component
    • value

      public Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component
    • quality

      public QualityCode quality()
      Returns the value of the quality record component.
      Returns:
      the value of the quality record component