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

Class RawQueryOptions

java.lang.Object

com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<K,DataPointType>

com.inductiveautomation.historian.common.model.options.DataPointQueryOptions<RawQueryKey>

com.inductiveautomation.historian.common.model.options.RawQueryOptions

All Implemented Interfaces:

QueryOptions<RawQueryKey,DataPointType>

public final class RawQueryOptions
extends DataPointQueryOptions<RawQueryKey>

Represents the options for querying raw data points.

This final class extends DataPointQueryOptions with a specific query key type of RawQueryKey. It provides functionality for building and retrieving query options specific to raw data points.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RawQueryOptions.Builder	A builder class for constructing instances of RawQueryOptions.

Nested classes/interfaces inherited from class com.inductiveautomation.historian.common.model.options.DataPointQueryOptions

DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey,B extends DataPointQueryOptions.DataQueryBuilder<K,B>>

Nested classes/interfaces inherited from class com.inductiveautomation.historian.common.model.options.AbstractQueryOptions

AbstractQueryOptions.BaseBuilder<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>,B extends AbstractQueryOptions.BaseBuilder<K,T,B>>

Field Summary

Fields inherited from class com.inductiveautomation.historian.common.model.options.AbstractQueryOptions

extendedProperties, queryKeys, returnSize, timeRange

Method Summary

Modifier and Type	Method	Description
static RawQueryOptions.Builder	builder()	Creates a new RawQueryOptions.Builder instance for constructing RawQueryOptions.
static RawQueryOptions.Builder	builder(RawQueryOptions options)	Creates a new RawQueryOptions.Builder instance initialized with the values of the provided RawQueryOptions.
DataPointType	getPointType()	Retrieves the type of the data point associated with this query.
String	toString()	Returns a string representation of this RawQueryOptions instance.

Methods inherited from class com.inductiveautomation.historian.common.model.options.DataPointQueryOptions

areObservationsExcluded, getQualityLevelFilter

Methods inherited from class com.inductiveautomation.historian.common.model.options.AbstractQueryOptions

getExtendedProperties, getExtendedPropertyValue, getQueryKeys, getReturnSize, getTimeRange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getPointType

public DataPointType getPointType()

Retrieves the type of the data point associated with this query.

Returns:

The DataPointType, which is StandardDataPointType.ATOMIC.

toString

public String toString()

Returns a string representation of this RawQueryOptions instance.

Overrides:

toString in class DataPointQueryOptions<RawQueryKey>

Returns:

A string representation of this object.

builder

public static RawQueryOptions.Builder builder()

Creates a new RawQueryOptions.Builder instance for constructing RawQueryOptions.

Returns:

A new RawQueryOptions.Builder.

builder

public static RawQueryOptions.Builder builder(RawQueryOptions options)

Creates a new RawQueryOptions.Builder instance initialized with the values of the provided RawQueryOptions.

Parameters:

options - The RawQueryOptions to copy values from.

Returns:

A new RawQueryOptions.Builder.