Package com.thingworx.types.data.filters

Class TagFilter

java.lang.Object

com.thingworx.types.data.filters.TagFilter

All Implemented Interfaces:

IFilter

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class TagFilter
extends java.lang.Object
implements IFilter

Filter which applies a tag matching criteria.

Constructor Summary

Constructors

Constructor	Description
TagFilter(java.lang.String fieldName, TagCollection tags, boolean inclusive)

Method Summary

Modifier and Type	Method	Description
boolean	evaluateFilter(ValueCollection row)
boolean	evaluateValue(IPrimitiveType iPrimitive)
java.lang.String	getFieldName()
java.lang.String	getFilterExpression()	Gets the filter expression.
TagCollection	getTagCollection()
boolean	isInclusive()
void	resolveFields(DataShapeDefinition metadata)
void	setFieldName(java.lang.String value)
void	setFilterExpression(java.lang.String value)	Sets the filter expression.
org.json.JSONObject	toJSON()	Produces JSON representation of this filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagFilter

@ThingworxExtensionApiMethod(since={6,6})
public TagFilter(java.lang.String fieldName,
                 TagCollection tags,
                 boolean inclusive)

Method Detail

resolveFields

@ThingworxExtensionApiMethod(since={6,6})
public void resolveFields(DataShapeDefinition metadata)

Specified by:

resolveFields in interface IFilter

getFieldName

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String getFieldName()

Specified by:

getFieldName in interface IFilter

setFieldName

@ThingworxExtensionApiMethod(since={6,6})
public void setFieldName(java.lang.String value)

Specified by:

setFieldName in interface IFilter

setFilterExpression

@ThingworxExtensionApiMethod(since={6,6})
public void setFilterExpression(java.lang.String value)

Description copied from interface: IFilter

Sets the filter expression.

Specified by:

setFilterExpression in interface IFilter

Parameters:

value - the filter expression

See Also:

IFilter.getFilterExpression()

getFilterExpression

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String getFilterExpression()

Description copied from interface: IFilter

Gets the filter expression.

Specified by:

getFilterExpression in interface IFilter

Returns:

the filter expression

See Also:

IFilter.setFilterExpression(String)

evaluateValue

@ThingworxExtensionApiMethod(since={6,6})
public boolean evaluateValue(IPrimitiveType iPrimitive)

Specified by:

evaluateValue in interface IFilter

evaluateFilter

@ThingworxExtensionApiMethod(since={6,6})
public boolean evaluateFilter(ValueCollection row)

Specified by:

evaluateFilter in interface IFilter

isInclusive

@ThingworxExtensionApiMethod(since={6,6})
public boolean isInclusive()

getTagCollection

@ThingworxExtensionApiMethod(since={6,6})
public TagCollection getTagCollection()

toJSON

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject toJSON()
                           throws org.json.JSONException

Produces JSON representation of this filter. Fields are as follows:

• CommonPropertyNames.PROP_TYPE: FilterFactory.FILTER_TAGGEDWITH when isInclusive() is true; otherwise FilterFactory.FILTER_NOT_TAGGEDWITH
• CommonPropertyNames.PROP_FIELDNAME: getFieldName() result
• CommonPropertyNames.PROP_TAGS: getTagCollection().toJSON() result

Specified by:

toJSON in interface IFilter

Returns:

JSON representation of this filter

Throws:

org.json.JSONException - Upon internal errors