Package com.inductiveautomation.ignition.common.tags.query

Class TagQuery.Builder

java.lang.Object

com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder

Enclosing class:

TagQuery

public static class TagQuery.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
TagQuery.Builder	andProperty(Property<?> property, ComparisonOperator op, Object v)
TagQuery.Builder	andProperty(String propertyName, ComparisonOperator op, Object v)
TagQuery.Builder	attributes(NodeAttribute... attributes)
TagQuery	build()
protected PropertyCondition	getPropertyCondition()
TagQuery.Builder	inheritanceHierarchy(String typeId, InheritanceRelationship relationship)
TagQuery.Builder	nodeId(String nodeId, ComparisonOperator op)
TagQuery.Builder	options(TagQuery.Options options)
TagQuery.Builder	orProperty(Property<?> property, ComparisonOperator op, Object v)
TagQuery.Builder	orProperty(String propertyName, ComparisonOperator op, Object v)
TagQuery.Builder	path(String path)	Expects a single tag path style string, with or without wildcards (*).
TagQuery.Builder	propertyDefined(Property<?> property)
TagQuery.Builder	propertyDefined(String propertyName)
TagQuery.Builder	propertyGroup(PropertyCondition.GroupPropertyCondition condition)
TagQuery.Builder	propertyNotDefined(Property<?> property)
TagQuery.Builder	propertyNotDefined(String propertyName)
TagQuery.Builder	propertyOverridden(Property<?> property)
TagQuery.Builder	propertyOverridden(String propertyName)
protected TagQuery.Builder	quality(QualityCode quality, boolean exact)
TagQuery.Builder	qualityIs(QualityCode code)	Creates a condition where the quality must be the exactly specified sub-code.
TagQuery.Builder	qualityLevelIs(QualityCode level)
TagQuery.Builder	returnProperties(Property<?>... properties)
TagQuery.Builder	superType(String typeId)	This adds a filter that will find instances that descend from the specified type id.
TagQuery.Builder	tagObjectType(TagObjectType type)	Adds a new allowed TagObjectType.
TagQuery.Builder	valueSource(String id)	Adds a new allowed values source id.

Methods inherited from class java.lang.Object

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

Method Details

options

public TagQuery.Builder options(TagQuery.Options options)

path

public TagQuery.Builder path(String path)

Expects a single tag path style string, with or without wildcards (*). If the tag provider is included in the path, it will be stripped out- path conditions are relative to the overall provider the query is being executed on.

qualityIs

public TagQuery.Builder qualityIs(QualityCode code)

Creates a condition where the quality must be the exactly specified sub-code.

qualityLevelIs

public TagQuery.Builder qualityLevelIs(QualityCode level)

quality

protected TagQuery.Builder quality(QualityCode quality,
 boolean exact)

tagObjectType

public TagQuery.Builder tagObjectType(TagObjectType type)

Adds a new allowed TagObjectType. Values of this type are treated as "or" alternatives.

nodeId

public TagQuery.Builder nodeId(String nodeId,
 ComparisonOperator op)

valueSource

public TagQuery.Builder valueSource(String id)

Adds a new allowed values source id. Values of this type are treated as "or" alternatives.

attributes

public TagQuery.Builder attributes(NodeAttribute... attributes)

superType

public TagQuery.Builder superType(String typeId)

This adds a filter that will find instances that descend from the specified type id. This is a shortcut for calling inheritanceHierarchy(typeId, InheritanceRelationship.SuperType).

Parameters:

typeId - UDT tag type id.

inheritanceHierarchy

public TagQuery.Builder inheritanceHierarchy(String typeId,
 InheritanceRelationship relationship)

getPropertyCondition

protected PropertyCondition getPropertyCondition()

andProperty

public TagQuery.Builder andProperty(Property<?> property,
 ComparisonOperator op,
 Object v)

andProperty

public TagQuery.Builder andProperty(String propertyName,
 ComparisonOperator op,
 Object v)

orProperty

public TagQuery.Builder orProperty(Property<?> property,
 ComparisonOperator op,
 Object v)

orProperty

public TagQuery.Builder orProperty(String propertyName,
 ComparisonOperator op,
 Object v)

propertyDefined

public TagQuery.Builder propertyDefined(Property<?> property)

propertyDefined

public TagQuery.Builder propertyDefined(String propertyName)

propertyNotDefined

public TagQuery.Builder propertyNotDefined(Property<?> property)

propertyNotDefined

public TagQuery.Builder propertyNotDefined(String propertyName)

propertyOverridden

public TagQuery.Builder propertyOverridden(Property<?> property)

propertyOverridden

public TagQuery.Builder propertyOverridden(String propertyName)

returnProperties

public TagQuery.Builder returnProperties(Property<?>... properties)

propertyGroup

public TagQuery.Builder propertyGroup(PropertyCondition.GroupPropertyCondition condition)

build

public TagQuery build()