Filters

AI-generated Key Takeaways

• Filters is a factory for creating filters used to construct a Query.

• It provides static methods for creating various types of filters, including logical combinations (and, or, not), comparisons (eq, greaterThan, lessThan), string matching (contains), and filters based on item ownership or sharing status (openedByMe, ownedByMe, sharedWithMe).

• These filters can be used to define specific criteria for retrieving items.

public class Filters extends Object

A factory for creating filters that are used to construct a Query.

Public Constructor Summary

Filters()

Public Method Summary

static Filter	and(Iterable<Filter> filters) Returns a filter that matches items which are matched by every element of filters.
static Filter	and(Filter filter, Filter... additionalFilters) Returns a logical expression which combines filters with the 'AND' operator.
static Filter	contains(SearchableMetadataField<String> field, String value) Returns a filter which checks whether value is a substring of field.
static Filter	eq(CustomPropertyKey key, String value) Returns a filter which checks whether a custom property with the specified key exists and its value equals value.
static <T> Filter	eq(SearchableMetadataField<T> field, T value) Returns a filter which checks if the value of field equals value.
static <T extends Comparable<T>> Filter	greaterThan(SearchableOrderedMetadataField<T> field, T value) Returns a filter which checks if the value of field is greater than value.
static <T extends Comparable<T>> Filter	greaterThanEquals(SearchableOrderedMetadataField<T> field, T value) Returns a filter which checks if the value of field is greater than or equal to value.
static <T> Filter	in(SearchableCollectionMetadataField<T> field, T value) Returns a filter which checks whether value is an element of field.
static <T extends Comparable<T>> Filter	lessThan(SearchableOrderedMetadataField<T> field, T value) Returns a filter which checks if the value of field is less than value.
static <T extends Comparable<T>> Filter	lessThanEquals(SearchableOrderedMetadataField<T> field, T value) Returns a filter which checks if the value of field is less than or equal to value.
static Filter	not(Filter toNegate) Returns the negation of an filter.
static Filter	openedByMe() Returns a filter that matches only items that the current user has opened in the past.
static Filter	or(Iterable<Filter> filters) Returns a filter that matches items which are matched by any element of filters.
static Filter	or(Filter filter, Filter... additionalFilters) Returns a filter that matches items which are matched by any of the provided filter parameters.
static Filter	ownedByMe() Returns a filter that matches only items that the current user owns.
static Filter	sharedWithMe() Returns a filter that matches only items that are shared with the current user.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Filters ()

Public Methods

public static Filter and (Iterable<Filter> filters)

Returns a filter that matches items which are matched by every element of filters.

public static Filter and (Filter filter, Filter... additionalFilters)

Returns a logical expression which combines filters with the 'AND' operator.

public static Filter contains (SearchableMetadataField<String> field, String value)

Returns a filter which checks whether value is a substring of field. This filter can only be used with fields that contain a string value.

public static Filter eq (CustomPropertyKey key, String value)

Returns a filter which checks whether a custom property with the specified key exists and its value equals value. The provided value may not be null.

public static Filter eq (SearchableMetadataField<T> field, T value)

Returns a filter which checks if the value of field equals value.

public static Filter greaterThan (SearchableOrderedMetadataField<T> field, T value)

Returns a filter which checks if the value of field is greater than value. This filter can only be used with fields that have a sort order.

public static Filter greaterThanEquals (SearchableOrderedMetadataField<T> field, T value)

Returns a filter which checks if the value of field is greater than or equal to value. This filter can only be used with fields that have a sort order.

public static Filter in (SearchableCollectionMetadataField<T> field, T value)

Returns a filter which checks whether value is an element of field. This filter can only be used with fields that contain a collection value.

public static Filter lessThan (SearchableOrderedMetadataField<T> field, T value)

Returns a filter which checks if the value of field is less than value. This filter can only be used with fields that have a sort order.

public static Filter lessThanEquals (SearchableOrderedMetadataField<T> field, T value)

Returns a filter which checks if the value of field is less than or equal to value. This filter can only be used with fields that have a sort order.

public static Filter not (Filter toNegate)

Returns the negation of an filter.

public static Filter openedByMe ()

Returns a filter that matches only items that the current user has opened in the past.

public static Filter or (Iterable<Filter> filters)

Returns a filter that matches items which are matched by any element of filters.

public static Filter or (Filter filter, Filter... additionalFilters)

Returns a filter that matches items which are matched by any of the provided filter parameters.

public static Filter ownedByMe ()

Returns a filter that matches only items that the current user owns.

public static Filter sharedWithMe ()

Returns a filter that matches only items that are shared with the current user.