Enum Class BoundingMode

java.lang.Object
java.lang.Enum<BoundingMode>
com.inductiveautomation.historian.common.model.options.BoundingMode
All Implemented Interfaces:
Serializable, Comparable<BoundingMode>, Constable

public enum BoundingMode extends Enum<BoundingMode>
Which bounding samples an aggregate query fetches beyond its time range: the latest sample strictly before startTime (pre-bound) and the earliest strictly after endTime (post-bound). They anchor interpolation in the first and last windows so those windows are not biased toward the in-range samples.

The search horizons are carried in BoundingOptions (see DataPointQueryOptions.getBounding() and DataPointQueryOptions.getBounding()); a null lookback or lookforward searches the full BoundingSearchWindow.DEFAULT_LOOKBACK.

Engines that declare BOUNDING_VALUES consume this directly; for the others the pipeline fetches the boundary samples with auxiliary raw reads.

  • Enum Constant Details

    • NONE

      public static final BoundingMode NONE
      Fetches no bounding samples.
    • PRE_ONLY

      public static final BoundingMode PRE_ONLY
      Fetches the latest sample strictly before startTime.
    • POST_ONLY

      public static final BoundingMode POST_ONLY
      Fetches the earliest sample strictly after endTime.
    • BOTH

      public static final BoundingMode BOTH
      Fetches both the pre-bound and the post-bound samples.
  • Method Details

    • values

      public static BoundingMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static BoundingMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • includesPre

      public boolean includesPre()
      Whether this mode requests a pre-bound (PRE_ONLY or BOTH).
    • includesPost

      public boolean includesPost()
      Whether this mode requests a post-bound (POST_ONLY or BOTH).