Package com.thingworx.types.data.filters

Class LikeFilter

java.lang.Object

com.thingworx.types.data.filters.LikeFilter

All Implemented Interfaces:

IFilter

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

Filter which applies a "like" (or "not like") criteria or regular-expression, rather than wildcard-based, forms of these criteria ("matches" and "not matches").

Constructor Summary

Constructors

Constructor	Description
LikeFilter(java.lang.String fieldName, java.lang.String expression, boolean isSQLPattern, boolean inclusive, boolean caseSensitive)	Constructs a LikeFilter instance.

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.
boolean	isCaseSensitive()
boolean	isInclusive()
boolean	isSQLPattern()
void	resolveFields(DataShapeDefinition metadata)
void	setFieldName(java.lang.String value)
void	setFilterExpression(java.lang.String expression)	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

LikeFilter

@ThingworxExtensionApiMethod(since={6,6})
public LikeFilter(java.lang.String fieldName,
                  java.lang.String expression,
                  boolean isSQLPattern,
                  boolean inclusive,
                  boolean caseSensitive)

Constructs a LikeFilter instance.

Note that the filtering behavior when using a wildcard expression (as opposed to regular expressions) is SQL-like, but not quite equivalent to SQL's wildcard expressions. Wildcard expressions here support '*' (or '%') as multi-character wildcards and '?' as a single character wildcard, but do not support '_' as a wildcard.

Parameters:

fieldName - Name of field to filter

expression - Wildcard or regular expression to match against

isSQLPattern - When true, the expression is treated as a wildcard expression; else it is treated as a regular expression

inclusive - True implies a "like" condition; false implies a "not like" condition

caseSensitive - Whether the matching should be case-sensitive

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 expression)

Description copied from interface: IFilter

Sets the filter expression.

Specified by:

setFilterExpression in interface IFilter

Parameters:

expression - 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)

isInclusive

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

isSQLPattern

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

isCaseSensitive

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

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

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_LIKE, FilterFactory.FILTER_NOT_LIKE, FilterFactory.FILTER_MATCHES, or FilterFactory.FILTER_NOT_MATCHES as appropriate, based on whether the filter's isInclusive() and isSQLPattern() state.
• CommonPropertyNames.PROP_FIELDNAME: getFieldName() result
• CommonPropertyNames.PROP_VALUE: when isSQLPattern() is true (only), getFilterExpression() result
• CommonPropertyNames.PROP_EXPRESSION: when isSQLPattern() is false (only), getFilterExpression() result
• CommonPropertyNames.PROP_ISCASESENSITIVE: isCaseSensitive() result, when true

Specified by:

toJSON in interface IFilter

Returns:

JSON representation of this filter

Throws:

org.json.JSONException - Upon internal errors