Record Class BoundingOptions

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.BoundingOptions
Record Components:
mode - the bounding mode; never null
lookback - the search horizon for the pre-bound sample, or null for the default; ignored when mode requests no pre-bound
lookforward - the search horizon for the post-bound sample, or null for the default; ignored when mode requests no post-bound

public record BoundingOptions(BoundingMode mode, @Nullable Duration lookback, @Nullable Duration lookforward) extends Record
Bounding-value configuration: the mode and the optional lookback and lookforward horizons the pipeline's BoundingValueResolver uses when it must fetch boundary samples itself. Both RawQueryOptions and AggregatedQueryOptions carry one; NONE is the default for both.

lookback and lookforward narrow the search: null searches the full BoundingSearchWindow.DEFAULT_LOOKBACK, and a supplied value is honored up to BoundingSearchWindow.MAX_LOOKBACK (see BoundingSearchWindow.pick(Duration)). They apply only when mode() is not BoundingMode.NONE.

  • Field Details

    • NONE

      public static final BoundingOptions NONE
      Requests no bounding samples.
  • Constructor Details

    • BoundingOptions

      public BoundingOptions(BoundingMode mode, @Nullable Duration lookback, @Nullable Duration lookforward)
      Creates an instance of a BoundingOptions record class.
      Parameters:
      mode - the value for the mode record component
      lookback - the value for the lookback record component
      lookforward - the value for the lookforward record component
  • Method Details

    • of

      public static BoundingOptions of(BoundingMode mode)
      Returns bounding with mode and the default horizons.
    • isEnabled

      public boolean isEnabled()
      Whether this configuration requests any bounding sample fetch.
    • 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.
    • mode

      public BoundingMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component
    • lookback

      public @Nullable Duration lookback()
      Returns the value of the lookback record component.
      Returns:
      the value of the lookback record component
    • lookforward

      public @Nullable Duration lookforward()
      Returns the value of the lookforward record component.
      Returns:
      the value of the lookforward record component