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

Class AnnotationQueryOptions

java.lang.Object

com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<AnnotationQueryKey,ComplexPointType>

com.inductiveautomation.historian.common.model.options.AnnotationQueryOptions

All Implemented Interfaces:

ComplexQueryOptions<AnnotationQueryKey>, QueryOptions<AnnotationQueryKey,ComplexPointType>

public final class AnnotationQueryOptions
extends AbstractQueryOptions<AnnotationQueryKey,ComplexPointType>
implements ComplexQueryOptions<AnnotationQueryKey>

Represents the options for querying annotation data points.

This class extends AbstractQueryOptions and implements ComplexQueryOptions to provide functionality specific to annotation queries, including type filtering.

Nested Class Summary

Nested Classes

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

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 AnnotationQueryOptions.Builder	builder()	Creates a new AnnotationQueryOptions.Builder instance for constructing AnnotationQueryOptions.
static AnnotationQueryOptions.Builder	builder(AnnotationQueryOptions options)	Creates a new AnnotationQueryOptions.Builder instance initialized with the values of an existing AnnotationQueryOptions.
ComplexPointType	getPointType()	Retrieves the type of the complex data point.
TypeFilter	getTypeFilter()	Retrieves the type filter used for the query.
String	toString()	Returns a string representation of the annotation query options.

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

getQueryKeys, getReturnSize, getTimeRange

Method Details

getPointType

public ComplexPointType getPointType()

Retrieves the type of the complex data point.

This implementation always returns StandardComplexPointType.ANNOTATION.

Specified by:

getPointType in interface QueryOptions<AnnotationQueryKey,ComplexPointType>

Returns:

The ComplexPointType representing the annotation type.

toString

public String toString()

Returns a string representation of the annotation query options.

Overrides:

toString in class AbstractQueryOptions<AnnotationQueryKey,ComplexPointType>

Returns:

A string representation of the object.

getTypeFilter

public TypeFilter getTypeFilter()

Retrieves the type filter used for the query.

Returns:

The TypeFilter specifying the types of annotations to include.

builder

public static AnnotationQueryOptions.Builder builder()

Creates a new AnnotationQueryOptions.Builder instance for constructing AnnotationQueryOptions.

Returns:

A new AnnotationQueryOptions.Builder.

builder

public static AnnotationQueryOptions.Builder builder(AnnotationQueryOptions options)

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

Parameters:

options - The existing AnnotationQueryOptions to copy.

Returns:

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