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 for
AnnotationQueryOptions.-
Field Summary
Fields inherited from class AbstractQueryOptions.BaseBuilder
queryKeys, returnSize -
Method Summary
Modifier and TypeMethodDescriptionallowedAuthors(String... authors) Restricts the filter to the given authors, leaving types unconstrained.allowedTypes(String... types) Restricts the filter to the given annotation types, leaving authors unconstrained.build()Builds the options.filter(AnnotationFilter filter) Sets the annotation filter; the default admits every annotation.protected AnnotationQueryOptions.Builderself()Methods inherited from class AbstractQueryOptions.BaseBuilder
addPropertyValue, addPropertyValues, addQueryKey, addQueryKeys, calculateTimeRange, clearQueryKeys, endTime, endTime, excludeBounds, includeBounds, rangeHours, rangeMinutes, rangeSeconds, returnSize, startTime, startTime
-
Method Details
-
filter
Sets the annotation filter; the default admits every annotation.- Parameters:
filter- the filter to apply- Returns:
- this builder
-
allowedTypes
Restricts the filter to the given annotation types, leaving authors unconstrained.- Parameters:
types- the types to admit- Returns:
- this builder
-
allowedAuthors
Restricts the filter to the given authors, leaving types unconstrained.- Parameters:
authors- the author names to admit- Returns:
- this builder
-
self
- Specified by:
selfin classAbstractQueryOptions.BaseBuilder<AnnotationQueryKey, ComplexPointType, AnnotationQueryOptions.Builder>
-
build
Builds the options.- Specified by:
buildin classAbstractQueryOptions.BaseBuilder<AnnotationQueryKey, ComplexPointType, AnnotationQueryOptions.Builder>- Returns:
- the new options.
-