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

Class MetadataQueryOptions.Builder

java.lang.Object

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

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

Enclosing class:

MetadataQueryOptions

public static class MetadataQueryOptions.Builder
extends AbstractQueryOptions.BaseBuilder<MetadataQueryKey,ComplexPointType,MetadataQueryOptions.Builder>

A builder class for constructing instances of MetadataQueryOptions.

Field Summary

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

returnSize

Method Summary

Modifier and Type	Method	Description
MetadataQueryOptions.Builder	addMetadataFilter(PropertySet propertySet)	Adds multiple metadata filters using the specified PropertySet.
MetadataQueryOptions.Builder	addMetadataFilter(PropertyValue propertyValue)	Adds a metadata filter using the specified PropertyValue.
MetadataQueryOptions.Builder	addMetadataFilter(String key, Object value)	Adds a metadata filter with the specified key and value.
MetadataQueryOptions	build()	Builds and returns a new MetadataQueryOptions instance.
protected MetadataQueryOptions.Builder	self()	Returns this Builder instance for method chaining.

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

addPropertyValue, addPropertyValues, addQueryKey, addQueryKeys, calculateTimeRange, clearQueryKeys, endTime, endTime, excludeBounds, includeBounds, rangeHours, rangeMinutes, rangeSeconds, returnSize, startTime, startTime

Methods inherited from class java.lang.Object

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

Method Details

self

protected MetadataQueryOptions.Builder self()

Returns this Builder instance for method chaining.

Specified by:

self in class AbstractQueryOptions.BaseBuilder<MetadataQueryKey,ComplexPointType,MetadataQueryOptions.Builder>

Returns:

This Builder.

addMetadataFilter

public MetadataQueryOptions.Builder addMetadataFilter(String key,
 Object value)

Adds a metadata filter with the specified key and value.

Parameters:

key - The key of the metadata filter.

value - The value of the metadata filter.

Returns:

This Builder instance for method chaining.

addMetadataFilter

public MetadataQueryOptions.Builder addMetadataFilter(PropertyValue propertyValue)

Adds a metadata filter using the specified PropertyValue.

Parameters:

propertyValue - The PropertyValue to add to the filter.

Returns:

This Builder instance for method chaining.

addMetadataFilter

public MetadataQueryOptions.Builder addMetadataFilter(PropertySet propertySet)

Adds multiple metadata filters using the specified PropertySet.

Parameters:

propertySet - The PropertySet containing the filters to add.

Returns:

This Builder instance for method chaining.

build

public MetadataQueryOptions build()

Builds and returns a new MetadataQueryOptions instance.

Specified by:

build in class AbstractQueryOptions.BaseBuilder<MetadataQueryKey,ComplexPointType,MetadataQueryOptions.Builder>

Returns:

A new MetadataQueryOptions.