io.sphere.sdk.search.model

Interface FilterSearchModel<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Known Subinterfaces:

ProductCategoriesIdTermFilterSearchModel<T>, TermFilterExistsAndMissingSearchModel<T,V>, TermFilterSearchModel<T,V>

All Known Implementing Classes:

RangeTermFilterSearchModel, TermFilterSearchModelImpl

public interface FilterSearchModel<T,V>

Model to build filters.

Method Summary

Modifier and Type	Method and Description
List<FilterExpression<T>>	containsAll(Iterable<V> values) Generates an expression to select all elements with attributes matching all the given values.
List<FilterExpression<T>>	containsAllAsString(Iterable<String> values) Generates an expression to select all elements with attributes matching all the given values.
List<FilterExpression<T>>	containsAny(Iterable<V> values) Generates an expression to select all elements with attributes matching any of the given values.
List<FilterExpression<T>>	containsAnyAsString(Iterable<String> values) Generates an expression to select all elements with attributes matching any of the given values.
SearchModel<T>	getSearchModel() The search model for the filter.
List<FilterExpression<T>>	is(V value) Generates an expression to select all elements with the given attribute value.
default List<FilterExpression<T>>	isIn(Iterable<V> values) Generates an expression to select all elements with attributes matching any of the given values.

Method Detail

getSearchModel

SearchModel<T> getSearchModel()

The search model for the filter.

Returns:

the filter search model

is

List<FilterExpression<T>> is(V value)

Generates an expression to select all elements with the given attribute value. For example: filtering by "red" would select only those elements with "red" value.

Parameters:

value - the value to filter by

Returns:

a filter expression for the given value

isIn

default List<FilterExpression<T>> isIn(Iterable<V> values)

Generates an expression to select all elements with attributes matching any of the given values. For example: filtering by ["red", "blue"] would select only those elements with either "red" or "blue" value.

Alias for containsAny(Iterable).

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAny

List<FilterExpression<T>> containsAny(Iterable<V> values)

Generates an expression to select all elements with attributes matching any of the given values. For example: filtering by ["red", "blue"] would select only those elements with either "red" or "blue" value.

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAll

List<FilterExpression<T>> containsAll(Iterable<V> values)

Generates an expression to select all elements with attributes matching all the given values. For example: filtering by ["red", "blue"] would select only those elements with both "red" and "blue" values.

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAnyAsString

List<FilterExpression<T>> containsAnyAsString(Iterable<String> values)

Generates an expression to select all elements with attributes matching any of the given values. For example: filtering by ["red", "blue"] would select only those elements with either "red" or "blue" value.

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAllAsString

List<FilterExpression<T>> containsAllAsString(Iterable<String> values)

Generates an expression to select all elements with attributes matching all the given values. For example: filtering by ["red", "blue"] would select only those elements with both "red" and "blue" values.

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values