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 TypeMethodDescriptionallowedTypes
(String... types) Configures the type filter to include specific annotation types.build()
Builds and returns a newAnnotationQueryOptions
instance.protected AnnotationQueryOptions.Builder
self()
Returns the current builder instance.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
-
Method Details
-
typeFilter
Sets the type filter for the query.- Parameters:
typeFilter
- TheTypeFilter
to use.- Returns:
- The current builder instance.
-
allowedTypes
Configures the type filter to include specific annotation types.- Parameters:
types
- The annotation types to include.- Returns:
- The current builder instance.
-
self
Returns the current builder instance.- Specified by:
self
in classAbstractQueryOptions.BaseBuilder<AnnotationQueryKey,
ComplexPointType, AnnotationQueryOptions.Builder> - Returns:
- The current builder instance.
-
build
Builds and returns a newAnnotationQueryOptions
instance.- Specified by:
build
in classAbstractQueryOptions.BaseBuilder<AnnotationQueryKey,
ComplexPointType, AnnotationQueryOptions.Builder> - Returns:
- A new
AnnotationQueryOptions
instance.
-