Record Class EngineDirective

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.EngineDirective
Record Components:
gap - how the engine treats windows without samples.
edges - the windows the engine returns edges for.
shape - SLOPED or STEPPED when the query forces the shape a time-weighted aggregate integrates over; AUTO leaves it to the engine: the tag's stored interpolation, else the stored values' type (floating point sloped, any other stepped).

public record EngineDirective(EngineDirective.GapPolicy gap, EngineDirective.EdgeRequest edges, Interpolation shape) extends Record
What the gateway asks an engine to do for one aggregated key it computes natively: how to treat windows without samples, which window edges to return, and the signal's shape between samples. The gateway resolves both from the key's interpolation and fill and owns them; an engine sees only the directive, never the interpolation or the fill word.
  • Constructor Details

  • Method Details

    • forWindows

      public static EngineDirective forWindows(FillMode requestedFill, FillMode resolvedFill, Interpolation shape)
      Resolves a directive for windows computed from their own samples. resolvedFill is the type-aware fill; a column that cannot ramp carries under a requested LINEAR fill, and Leave empty returns no row for a window without samples.
    • forEdges

      public static EngineDirective forEdges(AggregationType type, DataType inputType, boolean readsWindowNotEdges, Interpolation shape)
      Resolves a directive for windows computed from bounds. readsWindowNotEdges identifies a window-aware fold that does not consume each row's edges.
    • 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.
    • gap

      Returns the value of the gap record component.
      Returns:
      the value of the gap record component
    • edges

      Returns the value of the edges record component.
      Returns:
      the value of the edges record component
    • shape

      public Interpolation shape()
      Returns the value of the shape record component.
      Returns:
      the value of the shape record component