io.sphere.sdk.search.model

Interface FacetedSearchSearchModel<T>

Type Parameters:

T - type of the resource

All Known Implementing Classes:

RangeTermFacetedSearchSearchModel, TermFacetedSearchSearchModel

public interface FacetedSearchSearchModel<T>

Model to build facets and filters.

Method Summary

Modifier and Type	Method and Description
TermFacetedSearchExpression<T>	allTerms() Generates an expression to select all elements, without filtering, along with the facet for all terms for this attribute.
TermFacetedSearchExpression<T>	containsAll(Iterable<String> values) Generates an expression to select all elements with attributes matching all the given values, along with the facet for all terms for this attribute.
TermFacetedSearchExpression<T>	containsAny(Iterable<String> values) Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute.
SearchModel<T>	getSearchModel() The search model for the faceted search.
TermFacetedSearchExpression<T>	is(String value) Generates an expression to select all elements with the given attribute value, along with the facet for all terms for this attribute.
default TermFacetedSearchExpression<T>	isIn(Iterable<String> values) Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute.

Method Detail

getSearchModel

SearchModel<T> getSearchModel()

The search model for the faceted search.

Returns:

the faceted search model

allTerms

TermFacetedSearchExpression<T> allTerms()

Generates an expression to select all elements, without filtering, along with the facet for all terms for this attribute.

Returns:

a bundle of an empty filter expression and a facet expression for all terms

is

TermFacetedSearchExpression<T> is(String value)

Generates an expression to select all elements with the given attribute value, along with the facet for all terms for this attribute. For example: filtering by "red" color would select only those elements with "red" value, while the color facet would contain all possible values.

Parameters:

value - the value to filter by

Returns:

a bundle of the filter expressions for the given value and a facet expression for all terms

isIn

default TermFacetedSearchExpression<T> isIn(Iterable<String> values)

Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute. For example: filtering by ["red", "blue"] color would select only those elements with either "red" or "blue" value, while the color facet would contain all possible values.

Alias for containsAny(Iterable).

Parameters:

values - the values to filter by

Returns:

a bundle of the filter expressions for the given values and a facet expression for all terms

containsAny

TermFacetedSearchExpression<T> containsAny(Iterable<String> values)

Generates an expression to select all elements with attributes matching any of the given values, along with the facet for all terms for this attribute. For example: filtering by ["red", "blue"] color would select only those elements with either "red" or "blue" value, while the color facet would contain all possible values.

Parameters:

values - the values to filter by

Returns:

a bundle of the filter expressions for the given values and a facet expression for all terms

containsAll

TermFacetedSearchExpression<T> containsAll(Iterable<String> values)

Generates an expression to select all elements with attributes matching all the given values, along with the facet for all terms for this attribute. For example: filtering by ["red", "blue"] color would select only those elements with both "red" and "blue" values, while the color facet would contain all possible values.

Parameters:

values - the values to filter by

Returns:

a bundle of the filter expressions for the given values and a facet expression for all terms