Class DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey, B extends DataPointQueryOptions.DataQueryBuilder<K,B>>

java.lang.Object
com.inductiveautomation.historian.common.model.options.AbstractQueryOptions.BaseBuilder<K, DataPointType, B>
com.inductiveautomation.historian.common.model.options.DataPointQueryOptions.DataQueryBuilder<K,B>
Type Parameters:
K - the query key type.
B - the builder type.
Direct Known Subclasses:
AggregatedQueryOptions.Builder, RawQueryOptions.Builder
Enclosing class:
DataPointQueryOptions<K extends DataPointQueryKey>

public abstract static class DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey, B extends DataPointQueryOptions.DataQueryBuilder<K,B>> extends AbstractQueryOptions.BaseBuilder<K, DataPointType, B>
Builder for DataPointQueryOptions. Public so generic helpers can configure any data point query; instantiation is limited to the builders of RawQueryOptions and AggregatedQueryOptions.
  • Field Details

  • Constructor Details

    • DataQueryBuilder

      protected DataQueryBuilder()
    • DataQueryBuilder

      protected DataQueryBuilder(DataPointQueryOptions<K> options)
  • Method Details

    • bounding

      public B bounding(BoundingOptions bounding)
      Sets the bounding-value configuration; default BoundingOptions.NONE.
      Parameters:
      bounding - the bounding options; use BoundingOptions.NONE to disable.
      Returns:
      this builder.
    • addQualityLevel

      public B addQualityLevel(QualityCode.Level... levels)
      Adds quality levels to the filter; the first call starts from no level.
      Parameters:
      levels - the levels to include.
      Returns:
      this builder.
    • qualityLevelFilter

      public B qualityLevelFilter(QualityLevelFilter filter)
      Replaces the accepted quality levels.
      Parameters:
      filter - the levels to accept.
      Returns:
      this builder.
    • applyQualityLevelMask

      public B applyQualityLevelMask(int inputMask)
      Adds the levels in a mask to the filter; the first call starts from no level.
      Parameters:
      inputMask - the mask.
      Returns:
      this builder.
    • setQualityLevelMask

      public B setQualityLevelMask(int inputMask)
      Replaces the filter with exactly the levels in a mask.
      Parameters:
      inputMask - the mask. 0 rejects every level: a raw query returns nothing and AggregatedQueryOptions.Builder.build() rejects it.
      Returns:
      this builder.
    • includeAllQuality

      public B includeAllQuality(boolean includeAll)
      Includes all quality levels when true; false changes nothing.
      Parameters:
      includeAll - whether to include all levels.
      Returns:
      this builder.
    • includeGoodQuality

      public B includeGoodQuality(boolean includeGood)
      Includes Good when true; false changes nothing.
      Parameters:
      includeGood - whether to include Good.
      Returns:
      this builder.
    • includeUncertainQuality

      public B includeUncertainQuality(boolean includeUncertain)
      Includes Uncertain when true; false changes nothing.
      Parameters:
      includeUncertain - whether to include Uncertain.
      Returns:
      this builder.
    • includeBadQuality

      public B includeBadQuality(boolean includeBad)
      Includes Bad when true; false changes nothing.
      Parameters:
      includeBad - whether to include Bad.
      Returns:
      this builder.
    • includeErrorQuality

      public B includeErrorQuality(boolean includeError)
      Includes Error when true; false changes nothing.
      Parameters:
      includeError - whether to include Error.
      Returns:
      this builder.
    • excludeObservations

      public B excludeObservations()
      Excludes observations from the results.
      Returns:
      this builder.