Class AggregatedQueryOptions
java.lang.Object
com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<AggregatedQueryKey, DataPointType>
com.inductiveautomation.historian.common.model.options.DataPointQueryOptions<AggregatedQueryKey>
com.inductiveautomation.historian.common.model.options.AggregatedQueryOptions
- All Implemented Interfaces:
QueryOptions<AggregatedQueryKey, DataPointType>
Options for an aggregated query: the base data point query settings plus the time window each
aggregate is computed over.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder forAggregatedQueryOptions; adds the time window and aggregation settings to the common query settings.Nested classes/interfaces inherited from class DataPointQueryOptions
DataPointQueryOptions.DataQueryBuilder<K,B> Nested classes/interfaces inherited from class AbstractQueryOptions
AbstractQueryOptions.BaseBuilder<K,T, B> -
Field Summary
Fields inherited from class AbstractQueryOptions
extendedProperties, queryKeys, returnSize, timeRange -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns whether the pipeline may move the window origin and width onto the serving engine's lattice.builder()Creates a builder.builder(AggregatedQueryOptions options) Creates a builder initialized from existing options.Returns the aggregate a key inherits when it names none.Returns the interpolation a key with none of its own, orInterpolation.AUTO, takes; defaultInterpolation.AUTO, each aggregate's own default.ReturnsStandardDataPointType.AGGREGATED.Returns the window count, which replaces the configured return size for aggregated queries.Returns the aggregation time window.booleanReturns whether a key's own fill that does not apply is rejected instead of answered as Auto.booleanReturns whether a key's own interpolation the aggregate does not offer is rejected instead of answered with the aggregate's default.toString()Methods inherited from class DataPointQueryOptions
areObservationsExcluded, getBounding, getQualityLevelFilter, getRequestedBounding, getRequestedQualityLevelFilterMethods inherited from class AbstractQueryOptions
getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getTimeRange
-
Method Details
-
builder
-
builder
Creates a builder initialized from existing options.- Parameters:
options- the options to copy.- Returns:
- a new builder.
-
getTimeWindow
Returns the aggregation time window.- Returns:
- the window; never
null.
-
alignsToEngineGrid
public boolean alignsToEngineGrid()Returns whether the pipeline may move the window origin and width onto the serving engine's lattice. -
getInterpolation
Returns the interpolation a key with none of its own, orInterpolation.AUTO, takes; defaultInterpolation.AUTO, each aggregate's own default.- Returns:
- the interpolation; never
null.
-
isStrictInterpolation
public boolean isStrictInterpolation()Returns whether a key's own interpolation the aggregate does not offer is rejected instead of answered with the aggregate's default. -
isStrictFillWords
public boolean isStrictFillWords()Returns whether a key's own fill that does not apply is rejected instead of answered as Auto. -
getDefaultAggregateId
Returns the aggregate a key inherits when it names none. If the path's type does not accept it, the historian answers the key with an aggregate the type does accept; an explicitly chosen aggregate the type does not accept fails. -
getReturnSize
Returns the window count, which replaces the configured return size for aggregated queries.- Specified by:
getReturnSizein interfaceQueryOptions<AggregatedQueryKey, DataPointType>- Overrides:
getReturnSizein classAbstractQueryOptions<AggregatedQueryKey, DataPointType>- Returns:
- the window count.
-
getPointType
ReturnsStandardDataPointType.AGGREGATED.- Returns:
- the point type.
-
toString
- Overrides:
toStringin classDataPointQueryOptions<AggregatedQueryKey>
-