Class AggregatedQueryOptions

All Implemented Interfaces:
QueryOptions<AggregatedQueryKey, DataPointType>

public final class AggregatedQueryOptions extends DataPointQueryOptions<AggregatedQueryKey>
Options for an aggregated query: the base data point query settings plus the time window each aggregate is computed over.
  • Method Details

    • builder

      public static AggregatedQueryOptions.Builder builder()
      Creates a builder.
      Returns:
      a new builder.
    • builder

      public static AggregatedQueryOptions.Builder builder(AggregatedQueryOptions options)
      Creates a builder initialized from existing options.
      Parameters:
      options - the options to copy.
      Returns:
      a new builder.
    • getTimeWindow

      public TimeWindow getTimeWindow()
      Returns the aggregation time window.
      Returns:
      the window; never null.
    • alignsToEngineGrid

      public boolean alignsToEngineGrid()
      Returns whether the pipeline may move the window origin and width onto the serving engine's lattice.
    • getInterpolation

      public Interpolation getInterpolation()
      Returns the interpolation a key with none of its own, or Interpolation.AUTO, takes; default Interpolation.AUTO, each aggregate's own default.
      Returns:
      the interpolation; never null.
    • isStrictInterpolation

      public boolean isStrictInterpolation()
      Returns whether a key's own interpolation the aggregate does not offer is rejected instead of answered with the aggregate's default.
    • isStrictFillWords

      public boolean isStrictFillWords()
      Returns whether a key's own fill that does not apply is rejected instead of answered as Auto.
    • getDefaultAggregateId

      public Optional<AggregateId> getDefaultAggregateId()
      Returns the aggregate a key inherits when it names none. If the path's type does not accept it, the historian answers the key with an aggregate the type does accept; an explicitly chosen aggregate the type does not accept fails.
    • getReturnSize

      public Optional<Integer> getReturnSize()
      Returns the window count, which replaces the configured return size for aggregated queries.
      Specified by:
      getReturnSize in interface QueryOptions<AggregatedQueryKey, DataPointType>
      Overrides:
      getReturnSize in class AbstractQueryOptions<AggregatedQueryKey, DataPointType>
      Returns:
      the window count.
    • getPointType

      public DataPointType getPointType()
      Returns:
      the point type.
    • toString

      public String toString()
      Overrides:
      toString in class DataPointQueryOptions<AggregatedQueryKey>