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

Class AnnotationQueryOptions.Builder

java.lang.Object

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

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

Enclosing class:

AnnotationQueryOptions

public static class AnnotationQueryOptions.Builder
extends AbstractQueryOptions.BaseBuilder<AnnotationQueryKey,ComplexPointType,AnnotationQueryOptions.Builder>

Builder class for constructing instances of AnnotationQueryOptions.

This class provides methods to configure the type filter and other related options.

Field Summary

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

returnSize

Method Summary

Modifier and Type	Method	Description
AnnotationQueryOptions.Builder	allowedTypes(String... types)	Configures the type filter to include specific annotation types.
AnnotationQueryOptions	build()	Builds and returns a new AnnotationQueryOptions instance.
protected AnnotationQueryOptions.Builder	self()	Returns the current builder instance.
AnnotationQueryOptions.Builder	typeFilter(TypeFilter typeFilter)	Sets the type filter for the query.

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

typeFilter

public AnnotationQueryOptions.Builder typeFilter(TypeFilter typeFilter)

Sets the type filter for the query.

Parameters:

typeFilter - The TypeFilter to use.

Returns:

The current builder instance.

allowedTypes

public AnnotationQueryOptions.Builder allowedTypes(String... types)

Configures the type filter to include specific annotation types.

Parameters:

types - The annotation types to include.

Returns:

The current builder instance.

self

protected AnnotationQueryOptions.Builder self()

Returns the current builder instance.

Specified by:

self in class AbstractQueryOptions.BaseBuilder<AnnotationQueryKey,ComplexPointType,AnnotationQueryOptions.Builder>

Returns:

The current builder instance.

build

public AnnotationQueryOptions build()

Builds and returns a new AnnotationQueryOptions instance.

Specified by:

build in class AbstractQueryOptions.BaseBuilder<AnnotationQueryKey,ComplexPointType,AnnotationQueryOptions.Builder>

Returns:

A new AnnotationQueryOptions instance.