Class AbstractQueryOptions<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>>
java.lang.Object
com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<K,T>
- Type Parameters:
K- the query key type.T- the point type.
- All Implemented Interfaces:
QueryOptions<K,T>
- Direct Known Subclasses:
AnnotationQueryOptions, DataPointQueryOptions, MetadataQueryOptions
public abstract class AbstractQueryOptions<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>>
extends Object
implements QueryOptions<K,T>
Base class for query options: query keys, time range, return size and extended properties. At
least one query key is required.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAbstractQueryOptions.BaseBuilder<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>, B extends AbstractQueryOptions.BaseBuilder<K,T, B>> Base builder forAbstractQueryOptions. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final PropertySetprotected final @Nullable Integerprotected final @Nullable TimeRange -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected <B extends AbstractQueryOptions.BaseBuilder<K,T, B>> AbstractQueryOptions(AbstractQueryOptions.BaseBuilder<K, T, B> builder) Creates options from a builder. -
Method Summary
Modifier and TypeMethodDescriptionReturns the extended properties.<V> Optional<V> getExtendedPropertyValue(Property<V> property) Returns an extended property value.Returns the query keys.Returns the return size, or empty if not specified.Returns the time range, or empty if not specified.toString()Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface QueryOptions
getPointType
-
Field Details
-
queryKeys
-
extendedProperties
-
timeRange
-
returnSize
-
-
Constructor Details
-
AbstractQueryOptions
protected <B extends AbstractQueryOptions.BaseBuilder<K,T, AbstractQueryOptionsB>> (AbstractQueryOptions.BaseBuilder<K, T, B> builder) Creates options from a builder.- Parameters:
builder- the builder.- Throws:
IllegalArgumentException- if the query keys are empty.
-
-
Method Details
-
getQueryKeys
Description copied from interface:QueryOptionsReturns the query keys.- Specified by:
getQueryKeysin interfaceQueryOptions<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>>
-
getTimeRange
Description copied from interface:QueryOptionsReturns the time range, or empty if not specified.- Specified by:
getTimeRangein interfaceQueryOptions<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>>
-
getReturnSize
Description copied from interface:QueryOptionsReturns the return size, or empty if not specified.- Specified by:
getReturnSizein interfaceQueryOptions<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>>
-
toString
-
getExtendedProperties
Returns the extended properties.- Returns:
- the properties.
-
getExtendedPropertyValue
-