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.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classDataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey, B extends DataPointQueryOptions.DataQueryBuilder<K,B>> Builder forDataPointQueryOptions.Nested classes/interfaces inherited from class AbstractQueryOptions
AbstractQueryOptions.BaseBuilder<K,T, B> -
Field Summary
Fields inherited from class AbstractQueryOptions
extendedProperties, queryKeys, returnSize, timeRange -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected <B extends DataPointQueryOptions.DataQueryBuilder<K,B>> DataPointQueryOptions(B builder) protected <B extends DataPointQueryOptions.DataQueryBuilder<K,B>> DataPointQueryOptions(B builder, BoundingOptions defaultBounding, QualityLevelFilter defaultQualityLevelFilter) -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns whether observations are excluded from the results.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.Returns the quality level filter.Returns the caller's bounding options, or empty when the query uses its default.Returns the caller's quality filter, or empty when the query uses its default.toString()Methods inherited from class AbstractQueryOptions
getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getReturnSize, getTimeRangeMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface QueryOptions
getPointType
-
Constructor Details
-
DataPointQueryOptions
-
DataPointQueryOptions
protected <B extends DataPointQueryOptions.DataQueryBuilder<K,B>> DataPointQueryOptions(B builder, BoundingOptions defaultBounding, QualityLevelFilter defaultQualityLevelFilter)
-
-
Method Details
-
areObservationsExcluded
public boolean areObservationsExcluded()Returns whether observations are excluded from the results.- Returns:
trueif they are.
-
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
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 toBoundingOptions.NONE.- Returns:
- the bounding configuration; never
null.
-
getRequestedQualityLevelFilter
Returns the caller's quality filter, or empty when the query uses its default. -
getRequestedBounding
Returns the caller's bounding options, or empty when the query uses its default. -
toString
- Overrides:
toStringin classAbstractQueryOptions<K extends DataPointQueryKey, DataPointType>
-