Package com.unboundid.scim2.common.filters

Class Filter

java.lang.Object

com.unboundid.scim2.common.filters.Filter

Direct Known Subclasses:

CombiningFilter, ComparisonFilter, ComplexValueFilter, NotFilter, PresentFilter

public abstract class Filter
extends Object

Base class for parsing and creating new SCIM 2 filter instances.

Constructor Summary

Constructors

Constructor	Description
Filter()

Method Summary

Modifier and Type	Method	Description
static Filter	and(Filter filter1, Filter filter2, Filter... filters)	Create a new and filter.
static Filter	and(String filter1, String filter2, String... filters)	Create a new and filter.
static Filter	and(List<Filter> filters)	Create a new and filter.
static Filter	co(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new contains filter.
static Filter	co(String attributePath, String filterValue)	Create a new contains filter.
static Filter	eq(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, byte[] filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, Boolean filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, Double filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, Float filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, Integer filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, Long filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, String filterValue)	Create a new equal filter.
static Filter	eq(String attributePath, Date filterValue)	Create a new equal filter.
static Filter	ew(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new ends with filter.
static Filter	ew(String attributePath, String filterValue)	Create a new ends with filter.
static Filter	fromString(String filterString)	Parse a filter from its string representation.
static Filter	ge(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new greater than or equal filter.
static Filter	ge(String attributePath, Double filterValue)	Create a new greater than or equal filter.
static Filter	ge(String attributePath, Float filterValue)	Create a new greater than or equal filter.
static Filter	ge(String attributePath, Integer filterValue)	Create a new greater than or equal filter.
static Filter	ge(String attributePath, Long filterValue)	Create a new greater than or equal filter.
static Filter	ge(String attributePath, String filterValue)	Create a new greater than or equal filter.
static Filter	ge(String attributePath, Date filterValue)	Create a new greater than or equal filter.
Path	getAttributePath()	Retrieve the path to the attribute to filter by, or null if this filter is not a comparison filter or a value filter for complex multi-valued attributes.
List<Filter>	getCombinedFilters()	Retrieve the combined filters for a logical combining filter.
com.fasterxml.jackson.databind.node.ValueNode	getComparisonValue()	Retrieve the comparison value, or null if this filter is not a comparison filter.
abstract FilterType	getFilterType()	Retrieve the filter type.
Filter	getInvertedFilter()	Retrieve the inverted filter for a not filter or null if this filter is not a not filter.
Filter	getValueFilter()	Retrieve the value filter for complex multi-valued attribute value filter or null if this filter is not a value filter.
static Filter	gt(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new greater than filter.
static Filter	gt(String attributePath, Double filterValue)	Create a new greater than filter.
static Filter	gt(String attributePath, Float filterValue)	Create a new greater than filter.
static Filter	gt(String attributePath, Integer filterValue)	Create a new greater than filter.
static Filter	gt(String attributePath, Long filterValue)	Create a new greater than filter.
static Filter	gt(String attributePath, String filterValue)	Create a new greater than filter.
static Filter	gt(String attributePath, Date filterValue)	Create a new greater than filter.
static Filter	hasComplexValue(Path attributePath, Filter valueFilter)	Create a new complex multi-valued attribute value filter.
static Filter	hasComplexValue(String attributePath, Filter valueFilter)	Create a new complex multi-valued attribute value filter.
static Filter	hasComplexValue(String attributePath, String valueFilter)	Create a new complex multi-valued attribute value filter.
boolean	isCombiningFilter()	Whether this filter is an and or or logical combining filter.
boolean	isComparisonFilter()	Whether this filter is a filter that compares attribute values against a comparison value.
boolean	isComplexValueFilter()	Whether this filter is a complex multi-valued attribute value filter.
boolean	isNotFilter()	Whether this filter is not filter.
static Filter	le(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new less than or equal filter.
static Filter	le(String attributePath, Double filterValue)	Create a new less than or equal filter.
static Filter	le(String attributePath, Float filterValue)	Create a new less than or equal filter.
static Filter	le(String attributePath, Integer filterValue)	Create a new less than or equal filter.
static Filter	le(String attributePath, Long filterValue)	Create a new less than or equal filter.
static Filter	le(String attributePath, String filterValue)	Create a new less than or equal filter.
static Filter	le(String attributePath, Date filterValue)	Create a new less than or equal filter.
static Filter	lt(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new less than filter.
static Filter	lt(String attributePath, Double filterValue)	Create a new less than filter.
static Filter	lt(String attributePath, Float filterValue)	Create a new less than filter.
static Filter	lt(String attributePath, Integer filterValue)	Create a new less than filter.
static Filter	lt(String attributePath, Long filterValue)	Create a new less than filter.
static Filter	lt(String attributePath, String filterValue)	Create a new less than filter.
static Filter	lt(String attributePath, Date filterValue)	Create a new less than filter.
static Filter	ne(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, byte[] filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, Boolean filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, Double filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, Float filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, Integer filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, Long filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, String filterValue)	Create a new not equal filter.
static Filter	ne(String attributePath, Date filterValue)	Create a new not equal filter.
static Filter	not(Filter filter)	Create a new not filter.
static Filter	not(String filter)	Create a new not filter.
static Filter	or(Filter filter1, Filter filter2, Filter... filters)	Create a new or filter.
static Filter	or(String filter1, String filter2, String... filters)	Create a new or filter.
static Filter	or(List<Filter> filters)	Create a new or filter.
static Filter	pr(Path attributePath)	Create a new present filter.
static Filter	pr(String attributePath)	Create a new present filter.
static Filter	sw(Path attributePath, com.fasterxml.jackson.databind.node.ValueNode filterValue)	Create a new starts with filter.
static Filter	sw(String attributePath, String filterValue)	Create a new starts with filter.
String	toString()
abstract void	toString(StringBuilder builder)	Append the string representation of the filter to the provided buffer.
abstract <R,P> R	visit(FilterVisitor<R,P> visitor, P param)	Visit this filter using the provided filter visitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

getFilterType

public abstract FilterType getFilterType()

Retrieve the filter type.

Returns:

The filter type.

visit

public abstract <R,P> R visit(FilterVisitor<R,P> visitor,
                                    P param)
                             throws ScimException

Visit this filter using the provided filter visitor.

Type Parameters:

R - The return type of the filter visitor.

P - The optional parameter type accepted by the filter visitor.

Parameters:

visitor - The FilterVisitor instance.

param - An optional parameter.

Returns:

The return type from the filter visitor.

Throws:

ScimException - The exception thrown from the filter visitor.

toString

public abstract void toString(StringBuilder builder)

Append the string representation of the filter to the provided buffer.

Parameters:

builder - The buffer to which the string representation of the filter is to be appended.

isCombiningFilter

public boolean isCombiningFilter()

Whether this filter is an and or or logical combining filter.

Returns:

true if this filter is an and or or logical combining filter or false otherwise.

getCombinedFilters

public List<Filter> getCombinedFilters()

Retrieve the combined filters for a logical combining filter.

Returns:

The filter components for a logical combining filter.

isNotFilter

public boolean isNotFilter()

Whether this filter is not filter.

Returns:

true if this filter is a not filter or false otherwise.

getInvertedFilter

public Filter getInvertedFilter()

Retrieve the inverted filter for a not filter or null if this filter is not a not filter.

Returns:

The inverted filter for a not filter or null if this filter is not a not' filter.

isComplexValueFilter

public boolean isComplexValueFilter()

Whether this filter is a complex multi-valued attribute value filter.

Returns:

true if this filter is a complex multi-valued attribute value filter or false otherwise.

getValueFilter

public Filter getValueFilter()

Retrieve the value filter for complex multi-valued attribute value filter or null if this filter is not a value filter.

Returns:

The value filter for complex multi-valued attribute value filter or null if this filter is not a value filter.

getAttributePath

public Path getAttributePath()

Retrieve the path to the attribute to filter by, or null if this filter is not a comparison filter or a value filter for complex multi-valued attributes.

Returns:

The attribute or sub-attribute to filter by

isComparisonFilter

public boolean isComparisonFilter()

Whether this filter is a filter that compares attribute values against a comparison value. The following are comparison filters: eq, ne, co, sw, ew, gt, ge, lt, le.

Returns:

true if this is a comparison filter or false otherwise.

getComparisonValue

public com.fasterxml.jackson.databind.node.ValueNode getComparisonValue()

Retrieve the comparison value, or null if this filter is not a comparison filter.

Returns:

The comparison value, or null if this filter is not a comparison filter.

toString

public String toString()

Overrides:

toString in class Object

eq

public static Filter eq(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

eq

public static Filter eq(String attributePath,
                        Integer filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        Long filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        Double filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        Float filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        Boolean filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equality filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        byte[] filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

eq

public static Filter eq(String attributePath,
                        Date filterValue)
                 throws BadRequestException

Create a new equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

ne

public static Filter ne(String attributePath,
                        Integer filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        Long filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        Double filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        Float filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        Boolean filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        byte[] filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ne

public static Filter ne(String attributePath,
                        Date filterValue)
                 throws BadRequestException

Create a new not equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new not equal filter.

Throws:

BadRequestException - If the path could not be parsed.

co

public static Filter co(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new contains filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new contains filter.

co

public static Filter co(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new contains filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new contains filter.

Throws:

BadRequestException - If the path could not be parsed.

sw

public static Filter sw(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new starts with filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new starts with filter.

sw

public static Filter sw(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new starts with filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new starts with filter.

Throws:

BadRequestException - If the path could not be parsed.

ew

public static Filter ew(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new ends with filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new starts with filter.

ew

public static Filter ew(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new ends with filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new starts with filter.

Throws:

BadRequestException - If the path could not be parsed.

pr

public static Filter pr(Path attributePath)

Create a new present filter.

Parameters:

attributePath - The path to the attribute to filter by.

Returns:

A new present filter.

pr

public static Filter pr(String attributePath)
                 throws BadRequestException

Create a new present filter.

Parameters:

attributePath - The path to the attribute to filter by.

Returns:

A new present filter.

Throws:

BadRequestException - If the path could not be parsed.

gt

public static Filter gt(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

gt

public static Filter gt(String attributePath,
                        Integer filterValue)
                 throws BadRequestException

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

Throws:

BadRequestException - If the path could not be parsed.

gt

public static Filter gt(String attributePath,
                        Long filterValue)
                 throws BadRequestException

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

Throws:

BadRequestException - If the path could not be parsed.

gt

public static Filter gt(String attributePath,
                        Double filterValue)
                 throws BadRequestException

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

Throws:

BadRequestException - If the path could not be parsed.

gt

public static Filter gt(String attributePath,
                        Float filterValue)
                 throws BadRequestException

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

Throws:

BadRequestException - If the path could not be parsed.

gt

public static Filter gt(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

Throws:

BadRequestException - If the path could not be parsed.

gt

public static Filter gt(String attributePath,
                        Date filterValue)
                 throws BadRequestException

Create a new greater than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than filter.

Throws:

BadRequestException - If the path could not be parsed.

ge

public static Filter ge(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

ge

public static Filter ge(String attributePath,
                        Integer filterValue)
                 throws BadRequestException

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ge

public static Filter ge(String attributePath,
                        Long filterValue)
                 throws BadRequestException

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ge

public static Filter ge(String attributePath,
                        Double filterValue)
                 throws BadRequestException

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ge

public static Filter ge(String attributePath,
                        Float filterValue)
                 throws BadRequestException

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ge

public static Filter ge(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

ge

public static Filter ge(String attributePath,
                        Date filterValue)
                 throws BadRequestException

Create a new greater than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

lt

public static Filter lt(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

lt

public static Filter lt(String attributePath,
                        Integer filterValue)
                 throws BadRequestException

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

lt

public static Filter lt(String attributePath,
                        Long filterValue)
                 throws BadRequestException

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

lt

public static Filter lt(String attributePath,
                        Double filterValue)
                 throws BadRequestException

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

lt

public static Filter lt(String attributePath,
                        Float filterValue)
                 throws BadRequestException

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

lt

public static Filter lt(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

lt

public static Filter lt(String attributePath,
                        Date filterValue)
                 throws BadRequestException

Create a new less than filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new greater than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

le

public static Filter le(Path attributePath,
                        com.fasterxml.jackson.databind.node.ValueNode filterValue)

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

le

public static Filter le(String attributePath,
                        Integer filterValue)
                 throws BadRequestException

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

le

public static Filter le(String attributePath,
                        Long filterValue)
                 throws BadRequestException

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

le

public static Filter le(String attributePath,
                        Double filterValue)
                 throws BadRequestException

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

le

public static Filter le(String attributePath,
                        Float filterValue)
                 throws BadRequestException

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

le

public static Filter le(String attributePath,
                        String filterValue)
                 throws BadRequestException

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

le

public static Filter le(String attributePath,
                        Date filterValue)
                 throws BadRequestException

Create a new less than or equal filter.

Parameters:

attributePath - The path to the attribute to filter by.

filterValue - The filter attribute value.

Returns:

A new less than or equal filter.

Throws:

BadRequestException - If the path could not be parsed.

and

public static Filter and(Filter filter1,
                         Filter filter2,
                         Filter... filters)

Create a new and filter.

Parameters:

filter1 - The first filter.

filter2 - The second filter.

filters - Additional filter components.

Returns:

A new and filter.

and

public static Filter and(String filter1,
                         String filter2,
                         String... filters)
                  throws BadRequestException

Create a new and filter.

Parameters:

filter1 - The first filter.

filter2 - The second filter.

filters - Additional filter components.

Returns:

A new and filter.

Throws:

BadRequestException - If one of the filters could not be parsed.

or

public static Filter or(Filter filter1,
                        Filter filter2,
                        Filter... filters)

Create a new or filter.

Parameters:

filter1 - The first filter.

filter2 - The second filter.

filters - Additional filter components.

Returns:

A new or filter.

or

public static Filter or(String filter1,
                        String filter2,
                        String... filters)
                 throws BadRequestException

Create a new or filter.

Parameters:

filter1 - The first filter.

filter2 - The second filter.

filters - Additional filter components.

Returns:

A new or filter.

Throws:

BadRequestException - If one of the filters could not be parsed.

and

public static Filter and(List<Filter> filters)

Create a new and filter.

Parameters:

filters - The filter components.

Returns:

A new and filter.

or

public static Filter or(List<Filter> filters)

Create a new or filter.

Parameters:

filters - The filter components.

Returns:

A new or filter.

not

public static Filter not(Filter filter)

Create a new not filter.

Parameters:

filter - The inverted filter.

Returns:

A new not filter.

not

public static Filter not(String filter)
                  throws BadRequestException

Create a new not filter.

Parameters:

filter - The inverted filter.

Returns:

A new not filter.

Throws:

BadRequestException - If the filter could not be parsed.

hasComplexValue

public static Filter hasComplexValue(Path attributePath,
                                     Filter valueFilter)

Create a new complex multi-valued attribute value filter.

Parameters:

attributePath - The path to the attribute to filter by.

valueFilter - The value filter.

Returns:

A new complex multi-valued attribute value filter.

hasComplexValue

public static Filter hasComplexValue(String attributePath,
                                     Filter valueFilter)
                              throws BadRequestException

Create a new complex multi-valued attribute value filter.

Parameters:

attributePath - The path to the attribute to filter by.

valueFilter - The value filter.

Returns:

A new complex multi-valued attribute value filter.

Throws:

BadRequestException - If the path could not be parsed.

hasComplexValue

public static Filter hasComplexValue(String attributePath,
                                     String valueFilter)
                              throws BadRequestException

Create a new complex multi-valued attribute value filter.

Parameters:

attributePath - The path to the attribute to filter by.

valueFilter - The value filter.

Returns:

A new complex multi-valued attribute value filter.

Throws:

BadRequestException - If the path or filter could not be parsed.

fromString

public static Filter fromString(String filterString)
                         throws BadRequestException

Parse a filter from its string representation.

Parameters:

filterString - The string representation of the filter expression.

Returns:

The parsed filter.

Throws:

BadRequestException - If the filter could not be parsed.