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

Class AggregatedQueryOptions.Builder

java.lang.Object

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

com.inductiveautomation.historian.common.model.options.DataPointQueryOptions.DataQueryBuilder<AggregatedQueryKey,AggregatedQueryOptions.Builder>

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

Enclosing class:

AggregatedQueryOptions

public static class AggregatedQueryOptions.Builder
extends DataPointQueryOptions.DataQueryBuilder<AggregatedQueryKey,AggregatedQueryOptions.Builder>

Builder class for constructing instances of AggregatedQueryOptions.

This class provides methods to configure the time window for aggregation and other related options. It extends DataPointQueryOptions.DataQueryBuilder to inherit common query-building functionality.

Field Summary

Fields inherited from class com.inductiveautomation.historian.common.model.options.DataPointQueryOptions.DataQueryBuilder

excludeObservations, levelBuilder

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

returnSize

Method Summary

Modifier and Type	Method	Description
AggregatedQueryOptions	build()	Builds and returns a new AggregatedQueryOptions instance.
protected AggregatedQueryOptions.Builder	self()	Returns the current builder instance.
AggregatedQueryOptions.Builder	withDayWindows(long days)	Configures the time window to use day-based windows.
AggregatedQueryOptions.Builder	withHourWindows(long hours)	Configures the time window to use hour-based windows.
AggregatedQueryOptions.Builder	withMinuteWindows(long minutes)	Configures the time window to use minute-based windows.
AggregatedQueryOptions.Builder	withMonthWindows(long months)	Configures the time window to use month-based windows.
AggregatedQueryOptions.Builder	withTimeWindow(TimeWindow window)	Sets the time window for the aggregation.
AggregatedQueryOptions.Builder	withWeekWindows(long weeks)	Configures the time window to use week-based windows.
AggregatedQueryOptions.Builder	withWindowSize(long size, ChronoUnit unit)	Sets the time window size and unit for the aggregation.
AggregatedQueryOptions.Builder	withYearWindows(long years)	Configures the time window to use year-based windows.

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

addQualityLevel, applyQualityLevelMask, excludeObservations, includeAllQuality, includeBadQuality, includeErrorQuality, includeGoodQuality, includeUncertainQuality

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

addPropertyValue, addPropertyValues, addQueryKey, addQueryKeys, calculateTimeRange, clearQueryKeys, endTime, endTime, excludeBounds, includeBounds, rangeHours, rangeMinutes, rangeSeconds, returnSize, startTime, startTime

Methods inherited from class java.lang.Object

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

Method Details

withTimeWindow

public AggregatedQueryOptions.Builder withTimeWindow(TimeWindow window)

Sets the time window for the aggregation.

Parameters:

window - The TimeWindow to use.

Returns:

The current builder instance.

withWindowSize

public AggregatedQueryOptions.Builder withWindowSize(long size,
 ChronoUnit unit)

Sets the time window size and unit for the aggregation.

Parameters:

size - The size of the time window.

unit - The ChronoUnit representing the unit of time.

Returns:

The current builder instance.

withHourWindows

public AggregatedQueryOptions.Builder withHourWindows(long hours)

Configures the time window to use hour-based windows.

Parameters:

hours - The number of hours per window.

Returns:

The current builder instance.

withMinuteWindows

public AggregatedQueryOptions.Builder withMinuteWindows(long minutes)

Configures the time window to use minute-based windows.

Parameters:

minutes - The number of minutes per window.

Returns:

The current builder instance.

withDayWindows

public AggregatedQueryOptions.Builder withDayWindows(long days)

Configures the time window to use day-based windows.

Parameters:

days - The number of days per window.

Returns:

The current builder instance.

withWeekWindows

public AggregatedQueryOptions.Builder withWeekWindows(long weeks)

Configures the time window to use week-based windows.

Parameters:

weeks - The number of weeks per window.

Returns:

The current builder instance.

withMonthWindows

public AggregatedQueryOptions.Builder withMonthWindows(long months)

Configures the time window to use month-based windows.

Parameters:

months - The number of months per window.

Returns:

The current builder instance.

withYearWindows

public AggregatedQueryOptions.Builder withYearWindows(long years)

Configures the time window to use year-based windows.

Parameters:

years - The number of years per window.

Returns:

The current builder instance.

self

protected AggregatedQueryOptions.Builder self()

Returns the current builder instance.

Specified by:

self in class AbstractQueryOptions.BaseBuilder<AggregatedQueryKey,DataPointType,AggregatedQueryOptions.Builder>

Returns:

The current builder instance.

build

public AggregatedQueryOptions build()

Builds and returns a new AggregatedQueryOptions instance.

If no explicit time window is set, it attempts to calculate one based on the return size and time range.

Specified by:

build in class AbstractQueryOptions.BaseBuilder<AggregatedQueryKey,DataPointType,AggregatedQueryOptions.Builder>

Returns:

A new AggregatedQueryOptions instance.

Throws:

IllegalStateException - If the time range or return size is not set.