Package com.thingworx.types.data.filters

Interface IFilter

All Known Implementing Classes:

AndFilterCollection, BetweenFilter, FilterCollection, LikeFilter, MissingValueFilter, NearFilter, OrFilterCollection, RangeFilter, SetFilter, TagFilter

@ThingworxExtensionApiClass(since={6,6})
public interface IFilter

Common interface for filter criteria for use with Query.

Method Summary

Modifier and Type	Method	Description
boolean	evaluateFilter(ValueCollection row)
boolean	evaluateValue(IPrimitiveType value)
String	getFieldName()
String	getFilterExpression()	Deprecated. no replacement
void	resolveFields(DataShapeDefinition fields)
void	setFieldName(String value)
void	setFilterExpression(String value)	Deprecated. no replacement
org.json.JSONObject	toJSON()	Produces JSON representation of this filter.

Method Details

getFieldName

@ThingworxExtensionApiMethod(since={6,6})
String getFieldName()

setFieldName

@ThingworxExtensionApiMethod(since={6,6})
void setFieldName(String value)

evaluateFilter

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

evaluateValue

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

getFilterExpression

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={7,1})
String getFilterExpression()

Deprecated.

no replacement

Gets the filter expression.

Returns:

the filter expression

See Also:

• setFilterExpression(String)

setFilterExpression

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={7,1})
void setFilterExpression(String value)

Deprecated.

no replacement

Sets the filter expression.

Parameters:

value - the filter expression

See Also:

• getFilterExpression()

resolveFields

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

toJSON

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

Produces JSON representation of this filter.

Returns:

JSON representation of this filter

Throws:

org.json.JSONException - Upon internal errors