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>
Builder for
MetadataQueryOptions.-
Field Summary
Fields inherited from class AbstractQueryOptions.BaseBuilder
queryKeys, returnSize -
Method Summary
Modifier and TypeMethodDescriptionaddMetadataFilter(PropertySet propertySet) Adds every property in the set as a metadata filter.addMetadataFilter(PropertyValue propertyValue) Adds a metadata filter.addMetadataFilter(String key, Object value) Adds a metadata filter.build()Builds the options.protected MetadataQueryOptions.Builderself()Methods inherited from class AbstractQueryOptions.BaseBuilder
addPropertyValue, addPropertyValues, addQueryKey, addQueryKeys, calculateTimeRange, clearQueryKeys, endTime, endTime, excludeBounds, includeBounds, rangeHours, rangeMinutes, rangeSeconds, returnSize, startTime, startTime
-
Method Details
-
self
- Specified by:
selfin classAbstractQueryOptions.BaseBuilder<MetadataQueryKey, ComplexPointType, MetadataQueryOptions.Builder>
-
addMetadataFilter
Adds a metadata filter.- Parameters:
key- the property keyvalue- the property value- Returns:
- this builder
-
addMetadataFilter
Adds a metadata filter.- Parameters:
propertyValue- the property value to filter on- Returns:
- this builder
-
addMetadataFilter
Adds every property in the set as a metadata filter.- Parameters:
propertySet- the filters to add- Returns:
- this builder
-
build
Builds the options.- Specified by:
buildin classAbstractQueryOptions.BaseBuilder<MetadataQueryKey, ComplexPointType, MetadataQueryOptions.Builder>- Returns:
- the new options.
-