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>
Options for an annotation query: the shared query options plus an
AnnotationFilter on
author and type.-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class AbstractQueryOptions
AbstractQueryOptions.BaseBuilder<K,T, B> -
Field Summary
Fields inherited from class AbstractQueryOptions
extendedProperties, queryKeys, returnSize, timeRange -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Returns a new builder.builder(AnnotationQueryOptions options) Returns a builder initialized fromoptions.Returns the filter restricting which annotations the query returns.ReturnsStandardComplexPointType.ANNOTATION.toString()Methods inherited from class AbstractQueryOptions
getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getReturnSize, getTimeRangeMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface QueryOptions
getQueryKeys, getReturnSize, getTimeRange
-
Method Details
-
getPointType
ReturnsStandardComplexPointType.ANNOTATION.- Specified by:
getPointTypein interfaceQueryOptions<AnnotationQueryKey, ComplexPointType>
-
toString
- Overrides:
toStringin classAbstractQueryOptions<AnnotationQueryKey, ComplexPointType>
-
getFilter
Returns the filter restricting which annotations the query returns. -
builder
Returns a new builder. -
builder
Returns a builder initialized fromoptions.- Parameters:
options- the options to copy
-