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

Interface QueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>

Type Parameters:
K - The type of the query key, which must extend QueryKey.
T - The type of the point, which must extend both TemporalPointType and QueryablePointType.
All Known Subinterfaces:
ComplexQueryOptions<K>
All Known Implementing Classes:
AbstractQueryOptions, AggregatedQueryOptions, AnnotationQueryOptions, DataPointQueryOptions, MetadataQueryOptions, RawQueryOptions
public interface QueryOptions<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>
Represents the options for querying supported queryable TemporalPoint.

This interface defines the contract for query options, including the query keys, point type, time range, and return size. It uses generic type parameters to ensure type safety for the query keys and point types.

  • Method Details

    • getQueryKeys

      List<K> getQueryKeys()
      Retrieves the list of query keys associated with the query.
      Returns:
      A List of query keys of type K.

    • getPointType

      T getPointType()
      Retrieves the type of the point being queried.
      Returns:
      The point type of type T.

    • getTimeRange

      Optional<TimeRange> getTimeRange()
      Retrieves the optional time range for the query.
      Returns:
      An Optional containing the TimeRange, or empty if not specified.

    • getReturnSize

      Optional<Integer> getReturnSize()
      Retrieves the optional return size for the query.
      Returns:
      An Optional containing the return size as an Integer, or empty if not specified.