Package com.thingworx.types.data.filters

Class FilterCollection

java.lang.Object

com.thingworx.types.data.filters.FilterCollection

All Implemented Interfaces:

IFilter

Direct Known Subclasses:

AndFilterCollection, OrFilterCollection

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class FilterCollection
extends Object
implements IFilter

Constructor Summary

Constructors

Constructor	Description
FilterCollection()

Method Summary

Modifier and Type	Method	Description
void	addFilter(IFilter filter)
void	clearFilters()
boolean	evaluateFilter(ValueCollection row)
boolean	evaluateValue(IPrimitiveType value)
String	getFieldName()
IFilter	getFilter(int i)
int	getFilterCount()
String	getFilterExpression()	Deprecated.
List<IFilter>	getFilters()
void	resolveFields(DataShapeDefinition fields)
void	setFieldName(String value)
void	setFilterExpression(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 Details

FilterCollection

public FilterCollection()

Method Details

getFilters

@ThingworxExtensionApiMethod(since={6,6})
public List<IFilter> getFilters()

getFilter

@ThingworxExtensionApiMethod(since={6,6})
public IFilter getFilter(int i)

addFilter

@ThingworxExtensionApiMethod(since={6,6})
public void addFilter(IFilter filter)

clearFilters

@ThingworxExtensionApiMethod(since={6,6})
public void clearFilters()

getFilterCount

@ThingworxExtensionApiMethod(since={6,6})
public int getFilterCount()

getFieldName

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

Specified by:

getFieldName in interface IFilter

setFieldName

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

Specified by:

setFieldName in interface IFilter

setFilterExpression

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={7,1})
public void setFilterExpression(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()

evaluateValue

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

Specified by:

evaluateValue in interface IFilter

evaluateFilter

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

Specified by:

evaluateFilter in interface IFilter

getFilterExpression

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={7,1})
public 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)

resolveFields

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

Specified by:

resolveFields in interface IFilter

toJSON

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

Description copied from interface: IFilter

Produces JSON representation of this filter.

Specified by:

toJSON in interface IFilter

Returns:

JSON representation of this filter

Throws:

org.json.JSONException - If an error occurs