com.thingworx.types.data.filters

Class MissingValueFilter

java.lang.Object

com.thingworx.types.data.filters.MissingValueFilter

All Implemented Interfaces:

IFilter

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

Filter which applies an "is null" (or "is not null") criteria.

Constructor Summary

Constructors

Constructor and Description
MissingValueFilter(java.lang.String fieldName, boolean inclusive)
MissingValueFilter(java.lang.String fieldName, java.lang.Boolean inclusive)

Method Summary

Modifier and Type	Method and Description
boolean	evaluateFilter(ValueCollection row)
boolean	evaluateValue(IPrimitiveType iPrimitive)
java.lang.String	getFieldName()
java.lang.String	getFilterExpression() Deprecated.
boolean	isInclusive()
void	resolveFields(DataShapeDefinition metadata)
void	setFieldName(java.lang.String value)
void	setFilterExpression(java.lang.String expression) Deprecated.
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

MissingValueFilter

@ThingworxExtensionApiMethod(since={6,6})
public MissingValueFilter(java.lang.String fieldName,
                                                                    java.lang.Boolean inclusive)

MissingValueFilter

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

Method Detail

resolveFields

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

Specified by:

resolveFields in interface IFilter

isInclusive

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

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

@Deprecated
 @ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={7,1})
public void setFilterExpression(java.lang.String expression)

Deprecated.

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

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

Deprecated.

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

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_MISSINGVALUE when isInclusive() is true; otherwise FilterFactory.FILTER_NOTMISSINGVALUE
• CommonPropertyNames.PROP_FIELDNAME: getFieldName() result

Specified by:

toJSON in interface IFilter

Returns:

JSON representation of this filter

Throws:

org.json.JSONException - Upon internal errors