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

Class AbstractQueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>

java.lang.Object

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

Type Parameters:

K - The type of the query key, extending QueryKey.

T - The type of the temporal point, extending TemporalPointType and QueryablePointType.

All Implemented Interfaces:

QueryOptions<K,T>

Direct Known Subclasses:

AnnotationQueryOptions, DataPointQueryOptions, MetadataQueryOptions

public abstract class AbstractQueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>
extends Object
implements QueryOptions<K,T>

Abstract base class for query options in the historian system.

This class provides a framework for defining query options, including query keys, extended properties, time range, and return size. It ensures that query keys are not empty and provides methods to retrieve these properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractQueryOptions.BaseBuilder<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>,B extends AbstractQueryOptions.BaseBuilder<K,T,B>>	Abstract base class for building AbstractQueryOptions.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PropertySet	extendedProperties
protected final List<K>	queryKeys
protected final Integer	returnSize
protected final TimeRange	timeRange

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractQueryOptions(AbstractQueryOptions.BaseBuilder<K,T,B> builder)	Constructs an instance of AbstractQueryOptions.

Method Summary

Modifier and Type	Method	Description
PropertySet	getExtendedProperties()	Retrieves the extended properties of the query options.
<V> Optional<V>	getExtendedPropertyValue(Property<V> property)	Retrieves the value of a specific extended property.
List<K>	getQueryKeys()	Retrieves the list of query keys associated with the query.
Optional<Integer>	getReturnSize()	Retrieves the optional return size for the query.
Optional<TimeRange>	getTimeRange()	Retrieves the optional time range for the query.
String	toString()

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

Field Details

queryKeys

protected final List<K extends QueryKey<T>> queryKeys

extendedProperties

protected final PropertySet extendedProperties

timeRange

@Nullable
protected final TimeRange timeRange

returnSize

@Nullable
protected final Integer returnSize

Constructor Details

AbstractQueryOptions

protected AbstractQueryOptions(AbstractQueryOptions.BaseBuilder<K,T,B> builder)

Constructs an instance of AbstractQueryOptions.

Validates that the query keys are not empty and initializes the time range, return size, query keys, and extended properties.

Parameters:

builder - The builder used to construct the query options.

Throws:

IllegalArgumentException - If the query keys are empty.

Method Details

getQueryKeys

public List<K> getQueryKeys()

Description copied from interface: QueryOptions

Retrieves the list of query keys associated with the query.

Specified by:

getQueryKeys in interface QueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>

Returns:

A List of query keys of type K.

getTimeRange

public Optional<TimeRange> getTimeRange()

Description copied from interface: QueryOptions

Retrieves the optional time range for the query.

Specified by:

getTimeRange in interface QueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>

Returns:

An Optional containing the TimeRange, or empty if not specified.

getReturnSize

public Optional<Integer> getReturnSize()

Description copied from interface: QueryOptions

Retrieves the optional return size for the query.

Specified by:

getReturnSize in interface QueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>

Returns:

An Optional containing the return size as an Integer, or empty if not specified.

toString

public String toString()

Overrides:

toString in class Object

getExtendedProperties

public PropertySet getExtendedProperties()

Retrieves the extended properties of the query options.

Returns:

The PropertySet containing the extended properties.

getExtendedPropertyValue

public <V> Optional<V> getExtendedPropertyValue(Property<V> property)

Retrieves the value of a specific extended property.

Type Parameters:

V - The type of the property value.

Parameters:

property - The property to retrieve.

Returns:

An Optional containing the property value, or empty if not set.