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

Class TagQuery

java.lang.Object

com.inductiveautomation.ignition.common.alarming.query.AbstractFilter<TagQueryTarget>

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

All Implemented Interfaces:

Condition<TagQueryTarget>, Filter<TagQueryTarget>, Serializable

public class TagQuery
extends AbstractFilter<TagQueryTarget>

A Tag Query is a set of conditions for querying tags. The target of the query and conditions is a TagQueryTarget. This is a way to bridge between a little special knowledge about the nature of the target, and the fact that the "tag" object is not defined in Common.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TagQuery.Builder
static class	TagQuery.Options
static class	TagQuery.TagPropertyField<T>
static class	TagQuery.TagQueryGson
protected static class	TagQuery.TagQueryTypeAdapter

Field Summary

Fields

Modifier and Type	Field	Description
static final Field<TagQueryTarget,Set<NodeAttribute>,SetCondition<NodeAttribute>>	NODE_ATTRIBUTES	Node Attributes are traits of a tag.
static final Field<TagQueryTarget,String,NodeIdCondition>	NODE_ID
static final Field<TagQueryTarget,TagPath,TagPathWithoutSourceCondition>	PATH
static final Field<TagQueryTarget,PropertySet,PropertyCondition>	PROPERTIES
static final Field<TagQueryTarget,QualityCode,ValueQualityCondition>	QUALITY	Allows filtering based on the tag's current quality.
static final Field<TagQueryTarget,TagObjectType,AnyOfCondition<TagObjectType>>	TAG_TYPE	Tag type is the core type of tag- udt, folder, atomic, etc.
static final Field<TagQueryTarget,TypeHierarchyContext,TypeHierarchyCondition.TypeHierarchyClause>	TYPE_HIERARCHY	Type Hierarchy is used to filter UDTs based on a relationship to a type.
static final Field<TagQueryTarget,String,AnyOfCondition<String>>	VALUE_SOURCE	The value source is the "type" of atomic tag it is- memory, query, etc.

Constructor Summary

Constructors

Constructor	Description
TagQuery()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected LoggerEx	getLogger()
TagQuery.Options	getOptions()
Set<Property<?>>	getReturnProperties()
int	hashCode()
static TagQuery.Builder	newBuilder()

Methods inherited from class com.inductiveautomation.ignition.common.alarming.query.AbstractFilter

addRawCondition, and, getConditionFor, getRawConditions, hasConditionFor, isOptimized, logCondition, markOptimized, passes, removeCondition, resetOptimized, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PATH

public static final Field<TagQueryTarget,TagPath,TagPathWithoutSourceCondition> PATH

QUALITY

public static final Field<TagQueryTarget,QualityCode,ValueQualityCondition> QUALITY

Allows filtering based on the tag's current quality.

VALUE_SOURCE

public static final Field<TagQueryTarget,String,AnyOfCondition<String>> VALUE_SOURCE

The value source is the "type" of atomic tag it is- memory, query, etc.

TAG_TYPE

public static final Field<TagQueryTarget,TagObjectType,AnyOfCondition<TagObjectType>> TAG_TYPE

Tag type is the core type of tag- udt, folder, atomic, etc.

TYPE_HIERARCHY

public static final Field<TagQueryTarget,TypeHierarchyContext,TypeHierarchyCondition.TypeHierarchyClause> TYPE_HIERARCHY

Type Hierarchy is used to filter UDTs based on a relationship to a type. Searches can be a single level if the "direct" relationships are used, or deep if the non-direct variation is used.

NODE_ATTRIBUTES

public static final Field<TagQueryTarget,Set<NodeAttribute>,SetCondition<NodeAttribute>> NODE_ATTRIBUTES

Node Attributes are traits of a tag. They are typically indicative of functionality defined on a tag, but could also be current state. See CommonTagAttributes

PROPERTIES

public static final Field<TagQueryTarget,PropertySet,PropertyCondition> PROPERTIES

NODE_ID

public static final Field<TagQueryTarget,String,NodeIdCondition> NODE_ID

Constructor Details

TagQuery

public TagQuery()

Method Details

getOptions

public TagQuery.Options getOptions()

newBuilder

public static TagQuery.Builder newBuilder()

getReturnProperties

public Set<Property<?>> getReturnProperties()

getLogger

protected LoggerEx getLogger()

Specified by:

getLogger in class AbstractFilter<TagQueryTarget>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractFilter<TagQueryTarget>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractFilter<TagQueryTarget>