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

Class AggregatedQueryOptions

java.lang.Object

com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<K,DataPointType>

com.inductiveautomation.historian.common.model.options.DataPointQueryOptions<AggregatedQueryKey>

com.inductiveautomation.historian.common.model.options.AggregatedQueryOptions

All Implemented Interfaces:

QueryOptions<AggregatedQueryKey,DataPointType>

public final class AggregatedQueryOptions
extends DataPointQueryOptions<AggregatedQueryKey>

Represents the options for querying aggregated data points.

This class extends DataPointQueryOptions and provides additional functionality specific to aggregated queries, such as defining a time window and calculating the number of windows within a given time range.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregatedQueryOptions.Builder	Builder class for constructing instances of AggregatedQueryOptions.

Nested classes/interfaces inherited from class com.inductiveautomation.historian.common.model.options.DataPointQueryOptions

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

Nested classes/interfaces inherited from class com.inductiveautomation.historian.common.model.options.AbstractQueryOptions

AbstractQueryOptions.BaseBuilder<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>,B extends AbstractQueryOptions.BaseBuilder<K,T,B>>

Field Summary

Fields inherited from class com.inductiveautomation.historian.common.model.options.AbstractQueryOptions

extendedProperties, queryKeys, returnSize, timeRange

Method Summary

Modifier and Type	Method	Description
static AggregatedQueryOptions.Builder	builder()	Creates a new AggregatedQueryOptions.Builder instance for constructing AggregatedQueryOptions.
static AggregatedQueryOptions.Builder	builder(AggregatedQueryOptions options)	Creates a new AggregatedQueryOptions.Builder instance initialized with the values of an existing AggregatedQueryOptions.
DataPointType	getPointType()	Retrieves the type of the data point.
Optional<Integer>	getReturnSize()	Retrieves the return size for the query.
TimeWindow	getTimeWindow()	Retrieves the time window used for the aggregation.
String	toString()	Returns a string representation of the aggregated query options.

Methods inherited from class com.inductiveautomation.historian.common.model.options.DataPointQueryOptions

areObservationsExcluded, getQualityLevelFilter

Methods inherited from class com.inductiveautomation.historian.common.model.options.AbstractQueryOptions

getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getTimeRange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

builder

public static AggregatedQueryOptions.Builder builder()

Creates a new AggregatedQueryOptions.Builder instance for constructing AggregatedQueryOptions.

Returns:

A new AggregatedQueryOptions.Builder.

builder

public static AggregatedQueryOptions.Builder builder(AggregatedQueryOptions options)

Creates a new AggregatedQueryOptions.Builder instance initialized with the values of an existing AggregatedQueryOptions.

Parameters:

options - The existing AggregatedQueryOptions to copy.

Returns:

A new AggregatedQueryOptions.Builder initialized with the values of the given options.

getTimeWindow

public TimeWindow getTimeWindow()

Retrieves the time window used for the aggregation.

Returns:

The TimeWindow.

getReturnSize

public Optional<Integer> getReturnSize()

Retrieves the return size for the query.

Overrides the base implementation to return the calculated window count instead of the configured return size.

Specified by:

getReturnSize in interface QueryOptions<AggregatedQueryKey,DataPointType>

Overrides:

getReturnSize in class AbstractQueryOptions<AggregatedQueryKey,DataPointType>

Returns:

An Optional containing the window count.

getPointType

public DataPointType getPointType()

Retrieves the type of the data point.

Returns:

The DataPointType, which is always StandardDataPointType.AGGREGATED.

toString

public String toString()

Returns a string representation of the aggregated query options.

Overrides:

toString in class DataPointQueryOptions<AggregatedQueryKey>

Returns:

A string representation of the object.