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

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 type of the query key, which must extend DataPointQueryKey.

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

Represents the base options for querying data points.

This abstract sealed class extends AbstractQueryOptions and provides additional functionality specific to data point queries, such as excluding observations and filtering by quality levels. It is extended by RawQueryOptions and AggregatedQueryOptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey,B extends DataPointQueryOptions.DataQueryBuilder<K,B>>	A builder class for constructing instances of DataPointQueryOptions.

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataPointQueryOptions(B builder)	Constructs a new instance of DataPointQueryOptions using the provided builder.

Method Summary

Modifier and Type	Method	Description
boolean	areObservationsExcluded()	Checks whether observations are excluded from the query results.
QualityLevelFilter	getQualityLevelFilter()	Retrieves the quality level filter associated with this query.
String	toString()

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

getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getReturnSize, getTimeRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.historian.common.model.options.QueryOptions

getPointType

Constructor Details

DataPointQueryOptions

protected DataPointQueryOptions(B builder)

Constructs a new instance of DataPointQueryOptions using the provided builder.

Type Parameters:

B - The type of the builder, which must extend DataPointQueryOptions.DataQueryBuilder.

Parameters:

builder - The builder used to configure this instance.

Method Details

areObservationsExcluded

public boolean areObservationsExcluded()

Checks whether observations are excluded from the query results.

Returns:

true if observations are excluded, false otherwise.

getQualityLevelFilter

public QualityLevelFilter getQualityLevelFilter()

Retrieves the quality level filter associated with this query.

Returns:

The QualityLevelFilter used for filtering quality levels.

toString

public String toString()

Overrides:

toString in class AbstractQueryOptions<K extends DataPointQueryKey,DataPointType>