Class DataPointQueryOptions<K extends DataPointQueryKey>

java.lang.Object
com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<K, DataPointType>
com.inductiveautomation.historian.common.model.options.DataPointQueryOptions<K>
Type Parameters:
K - the query key type.
All Implemented Interfaces:
QueryOptions<K, DataPointType>
Direct Known Subclasses:
AggregatedQueryOptions, RawQueryOptions

public abstract sealed class DataPointQueryOptions<K extends DataPointQueryKey> extends AbstractQueryOptions<K, DataPointType> permits RawQueryOptions, AggregatedQueryOptions
Base options for data point queries: observation exclusion, quality level filtering and bounding values. Extended by RawQueryOptions and AggregatedQueryOptions.
  • Constructor Details

  • Method Details

    • areObservationsExcluded

      public boolean areObservationsExcluded()
      Returns whether observations are excluded from the results.
      Returns:
      true if they are.
    • getQualityLevelFilter

      public QualityLevelFilter getQualityLevelFilter()
      Returns the quality level filter. On aggregated options this is the filter resolved at build: the caller's, or when none was set, every level under Legacy Compatible and Good under any other model.
      Returns:
      the filter.
    • getBounding

      public BoundingOptions getBounding()
      Returns the bounding-value configuration: whether to include the last sample before the range and the first after it, and the lookback and lookforward horizons. Defaults to BoundingOptions.NONE.
      Returns:
      the bounding configuration; never null.
    • getRequestedQualityLevelFilter

      public Optional<QualityLevelFilter> getRequestedQualityLevelFilter()
      Returns the caller's quality filter, or empty when the query uses its default.
    • getRequestedBounding

      public Optional<BoundingOptions> getRequestedBounding()
      Returns the caller's bounding options, or empty when the query uses its default.
    • toString

      public String toString()
      Overrides:
      toString in class AbstractQueryOptions<K extends DataPointQueryKey, DataPointType>