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 Summary
FieldsModifier and TypeFieldDescriptionprotected @Nullable BoundingOptionsprotected booleanprotected @Nullable QualityLevelFilter.BuilderFields inherited from class AbstractQueryOptions.BaseBuilder
queryKeys, returnSize -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotectedDataQueryBuilder(DataPointQueryOptions<K> options) -
Method Summary
Modifier and TypeMethodDescriptionaddQualityLevel(QualityCode.Level... levels) Adds quality levels to the filter; the first call starts from no level.applyQualityLevelMask(int inputMask) Adds the levels in a mask to the filter; the first call starts from no level.bounding(BoundingOptions bounding) Sets the bounding-value configuration; defaultBoundingOptions.NONE.Excludes observations from the results.includeAllQuality(boolean includeAll) Includes all quality levels whentrue;falsechanges nothing.includeBadQuality(boolean includeBad) Includes Bad whentrue;falsechanges nothing.includeErrorQuality(boolean includeError) Includes Error whentrue;falsechanges nothing.includeGoodQuality(boolean includeGood) Includes Good whentrue;falsechanges nothing.includeUncertainQuality(boolean includeUncertain) Includes Uncertain whentrue;falsechanges nothing.qualityLevelFilter(QualityLevelFilter filter) Replaces the accepted quality levels.setQualityLevelMask(int inputMask) Replaces the filter with exactly the levels in a mask.Methods inherited from class AbstractQueryOptions.BaseBuilder
addPropertyValue, addPropertyValues, addQueryKey, addQueryKeys, build, calculateTimeRange, clearQueryKeys, endTime, endTime, excludeBounds, includeBounds, rangeHours, rangeMinutes, rangeSeconds, returnSize, self, startTime, startTime
-
Field Details
-
excludeObservations
protected boolean excludeObservations -
bounding
-
levelBuilder
-
-
Constructor Details
-
DataQueryBuilder
protected DataQueryBuilder() -
DataQueryBuilder
-
-
Method Details
-
bounding
Sets the bounding-value configuration; defaultBoundingOptions.NONE.- Parameters:
bounding- the bounding options; useBoundingOptions.NONEto disable.- Returns:
- this builder.
-
addQualityLevel
Adds quality levels to the filter; the first call starts from no level.- Parameters:
levels- the levels to include.- Returns:
- this builder.
-
qualityLevelFilter
Replaces the accepted quality levels.- Parameters:
filter- the levels to accept.- Returns:
- this builder.
-
applyQualityLevelMask
Adds the levels in a mask to the filter; the first call starts from no level.- Parameters:
inputMask- the mask.- Returns:
- this builder.
-
setQualityLevelMask
Replaces the filter with exactly the levels in a mask.- Parameters:
inputMask- the mask.0rejects every level: a raw query returns nothing andAggregatedQueryOptions.Builder.build()rejects it.- Returns:
- this builder.
-
includeAllQuality
Includes all quality levels whentrue;falsechanges nothing.- Parameters:
includeAll- whether to include all levels.- Returns:
- this builder.
-
includeGoodQuality
Includes Good whentrue;falsechanges nothing.- Parameters:
includeGood- whether to include Good.- Returns:
- this builder.
-
includeUncertainQuality
Includes Uncertain whentrue;falsechanges nothing.- Parameters:
includeUncertain- whether to include Uncertain.- Returns:
- this builder.
-
includeBadQuality
Includes Bad whentrue;falsechanges nothing.- Parameters:
includeBad- whether to include Bad.- Returns:
- this builder.
-
includeErrorQuality
Includes Error whentrue;falsechanges nothing.- Parameters:
includeError- whether to include Error.- Returns:
- this builder.
-
excludeObservations
-