io.sphere.sdk.search.model

Interface TermFilterSearchModel<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Superinterfaces:

FilterSearchModel<T,V>

All Known Subinterfaces:

ProductCategoriesIdTermFilterSearchModel<T>, TermFilterExistsAndMissingSearchModel<T,V>

All Known Implementing Classes:

TermFilterSearchModelImpl

public interface TermFilterSearchModel<T,V>
extends FilterSearchModel<T,V>

Model to build term 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.
List<FilterExpression<T>>	is(V value) Generates an expression to select all elements with the given attribute value.
List<FilterExpression<T>>	isIn(Iterable<V> values) Generates an expression to select all elements with attributes matching any of the given values.
static <T,V> TermFilterSearchModel<T,V>	of(String attributePath, Function<V,String> typeSerializer) Creates an instance of the search model to generate term filters.

Methods inherited from interface io.sphere.sdk.search.model.FilterSearchModel

getSearchModel

Method Detail

containsAll

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

Description copied from interface: FilterSearchModel

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.

Specified by:

containsAll in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAllAsString

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

Description copied from interface: FilterSearchModel

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.

Specified by:

containsAllAsString in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAny

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

Description copied from interface: FilterSearchModel

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.

Specified by:

containsAny in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

containsAnyAsString

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

Description copied from interface: FilterSearchModel

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.

Specified by:

containsAnyAsString in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

is

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

Description copied from interface: FilterSearchModel

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.

Specified by:

is in interface FilterSearchModel<T,V>

Parameters:

value - the value to filter by

Returns:

a filter expression for the given value

isIn

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

Description copied from interface: FilterSearchModel

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 FilterSearchModel.containsAny(Iterable).

Specified by:

isIn in interface FilterSearchModel<T,V>

Parameters:

values - the values to filter by

Returns:

a filter expression for the given values

of

static <T,V> TermFilterSearchModel<T,V> of(String attributePath,
                                           Function<V,String> typeSerializer)

Creates an instance of the search model to generate term filters.

Type Parameters:

T - type of the resource

V - type of the value

Parameters:

attributePath - the path of the attribute as expected by Composable Commerce (e.g. "variants.attributes.color.key")

typeSerializer - the function to convert the provided value to a string accepted by Composable Commerce

Returns:

new instance of TermFilterSearchModel