Package com.inductiveautomation.historian.common.model.options

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 type of the query key, which must extend DataPointQueryKey.
B - The type of the builder, which must extend DataPointQueryOptions.DataQueryBuilder.
Direct Known Subclasses:
AggregatedQueryOptions.Builder, RawQueryOptions.Builder
Enclosing class:
DataPointQueryOptions<K extends DataPointQueryKey>
protected abstract static class DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey,B extends DataPointQueryOptions.DataQueryBuilder<K,B>> extends AbstractQueryOptions.BaseBuilder<K,DataPointType,B>
A builder class for constructing instances of DataPointQueryOptions.

  • Field Details

    • excludeObservations

      protected boolean excludeObservations

    • levelBuilder

      protected final QualityLevelFilter.Builder levelBuilder

  • Constructor Details

    • DataQueryBuilder

      protected DataQueryBuilder()
      Constructs a new, empty DataQueryBuilder.

    • DataQueryBuilder

      protected DataQueryBuilder(DataPointQueryOptions<K> options)
      Constructs a new DataQueryBuilder initialized with the values of the provided options.
      Parameters:
      options - The DataPointQueryOptions to copy values from.

  • Method Details

    • addQualityLevel

      public B addQualityLevel(QualityCode.Level... levels)
      Adds the specified quality levels to the filter.
      Parameters:
      levels - The quality levels to include.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • applyQualityLevelMask

      public B applyQualityLevelMask(int inputMask)
      Applies a quality level mask to the filter.
      Parameters:
      inputMask - The mask to apply.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • includeAllQuality

      public B includeAllQuality(boolean includeAll)
      Includes all quality levels in the filter if specified.
      Parameters:
      includeAll - true to include all quality levels, false otherwise.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • includeGoodQuality

      public B includeGoodQuality(boolean includeGood)
      Includes good quality levels in the filter if specified.
      Parameters:
      includeGood - true to include good quality levels, false otherwise.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • includeUncertainQuality

      public B includeUncertainQuality(boolean includeUncertain)
      Includes uncertain quality levels in the filter if specified.
      Parameters:
      includeUncertain - true to include uncertain quality levels, false otherwise.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • includeBadQuality

      public B includeBadQuality(boolean includeBad)
      Includes bad quality levels in the filter if specified.
      Parameters:
      includeBad - true to include bad quality levels, false otherwise.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • includeErrorQuality

      public B includeErrorQuality(boolean includeError)
      Includes error quality levels in the filter if specified.
      Parameters:
      includeError - true to include error quality levels, false otherwise.
      Returns:
      This DataQueryBuilder instance for method chaining.

    • excludeObservations

      public B excludeObservations()
      Excludes observations from the query results.
      Returns:
      This DataQueryBuilder instance for method chaining.