Record Class AggregateFunction.Cell

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.AggregateFunction.Cell
Enclosing interface:
AggregateFunction<ACC>

public static record AggregateFunction.Cell(@Nullable Object value, @Nullable QualityCode quality, boolean fromBounds, boolean raw) extends Record
One value of a finished window. A null quality leaves the stamp to the pipeline; a stated one is the fold's own. fromBounds marks a value answered from the samples around the window rather than inside it (a null when they give none): its stated quality is the cell's stamp as it stands, and a Double on an integer column is narrowed into the column type. raw marks the stored sample at the window start, taken as the answer.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Cell(@Nullable Object value, @Nullable QualityCode quality, boolean fromBounds)
    A cell that is not the stored sample at the window start.
    Cell(@Nullable Object value, @Nullable QualityCode quality, boolean fromBounds, boolean raw)
    Creates an instance of a Cell record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    boolean
    Returns the value of the fromBounds record component.
    final int
    Returns a hash code value for this object.
    of(@Nullable Object value)
    A value fold's answer: one cell the pipeline stamps, or no cell for null.
    @Nullable QualityCode
    Returns the value of the quality record component.
    boolean
    raw()
    Returns the value of the raw record component.
    final String
    Returns a string representation of this record class.
    @Nullable Object
    Returns the value of the value record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Cell

      public Cell(@Nullable Object value, @Nullable QualityCode quality, boolean fromBounds)
      A cell that is not the stored sample at the window start.
    • Cell

      public Cell(@Nullable Object value, @Nullable QualityCode quality, boolean fromBounds, boolean raw)
      Creates an instance of a Cell record class.
      Parameters:
      value - the value for the value record component
      quality - the value for the quality record component
      fromBounds - the value for the fromBounds record component
      raw - the value for the raw record component
  • Method Details

    • of

      public static List<AggregateFunction.Cell> of(@Nullable Object value)
      A value fold's answer: one cell the pipeline stamps, or no cell for null.
    • 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.
    • value

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

      public @Nullable QualityCode quality()
      Returns the value of the quality record component.
      Returns:
      the value of the quality record component
    • fromBounds

      public boolean fromBounds()
      Returns the value of the fromBounds record component.
      Returns:
      the value of the fromBounds record component
    • raw

      public boolean raw()
      Returns the value of the raw record component.
      Returns:
      the value of the raw record component