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

Class MetadataQueryOptions

java.lang.Object

com.inductiveautomation.historian.common.model.options.AbstractQueryOptions<MetadataQueryKey,ComplexPointType>

com.inductiveautomation.historian.common.model.options.MetadataQueryOptions

All Implemented Interfaces:

ComplexQueryOptions<MetadataQueryKey>, QueryOptions<MetadataQueryKey,ComplexPointType>

public final class MetadataQueryOptions
extends AbstractQueryOptions<MetadataQueryKey,ComplexPointType>
implements ComplexQueryOptions<MetadataQueryKey>, QueryOptions<MetadataQueryKey,ComplexPointType>

Represents the options for querying metadata points.

This final class extends AbstractQueryOptions with a specific query key type of MetadataQueryKey and a point type of ComplexPointType. It provides functionality for building and retrieving query options specific to metadata points.

Nested Class Summary

Nested Classes

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

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 MetadataQueryOptions.Builder	builder()	Creates a new MetadataQueryOptions.Builder instance for constructing MetadataQueryOptions.
static MetadataQueryOptions.Builder	builder(MetadataQueryOptions options)	Creates a new MetadataQueryOptions.Builder instance initialized with the values of the provided MetadataQueryOptions.
ComplexPointType	getPointType()	Retrieves the type of the complex point associated with this query.
PropertySet	getPropertyFilter()	Retrieves the property filter associated with this query.
String	toString()	Returns a string representation of this MetadataQueryOptions instance.

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

Methods inherited from interface com.inductiveautomation.historian.common.model.options.QueryOptions

getQueryKeys, getReturnSize, getTimeRange

Method Details

getPointType

public ComplexPointType getPointType()

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

Specified by:

getPointType in interface QueryOptions<MetadataQueryKey,ComplexPointType>

Returns:

The ComplexPointType, which is StandardComplexPointType.METADATA.

toString

public String toString()

Returns a string representation of this MetadataQueryOptions instance.

Overrides:

toString in class AbstractQueryOptions<MetadataQueryKey,ComplexPointType>

Returns:

A string representation of this object.

getPropertyFilter

public PropertySet getPropertyFilter()

Retrieves the property filter associated with this query.

Returns:

The PropertySet used for filtering properties.

builder

public static MetadataQueryOptions.Builder builder()

Creates a new MetadataQueryOptions.Builder instance for constructing MetadataQueryOptions.

Returns:

A new MetadataQueryOptions.Builder.

builder

public static MetadataQueryOptions.Builder builder(MetadataQueryOptions options)

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

Parameters:

options - The MetadataQueryOptions to copy values from.

Returns:

A new MetadataQueryOptions.Builder.