io.sphere.sdk.search.model

Class TermFacetedSearchSearchModel<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.TermFacetedSearchSearchModel<T>

Type Parameters:

T - type of the resource

All Implemented Interfaces:

FacetedSearchSearchModel<T>

public final class TermFacetedSearchSearchModel<T>
extends Base

Model to build term facets and filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchModel<T>	searchModel
protected static TypeSerializer<String>	TYPE_SERIALIZER

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.
static <T> TermFacetedSearchSearchModel<T>	of(String attributePath) Creates an instance of the search model to generate term faceted search expressions.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isIn

Field Detail

TYPE_SERIALIZER

protected static final TypeSerializer<String> TYPE_SERIALIZER

searchModel

protected final SearchModel<T> searchModel

Method Detail

allTerms

public TermFacetedSearchExpression<T> allTerms()

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

Specified by:

allTerms in interface FacetedSearchSearchModel<T>

Returns:

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

is

public 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.

Specified by:

is in interface FacetedSearchSearchModel<T>

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

containsAny

public 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.

Specified by:

containsAny in interface FacetedSearchSearchModel<T>

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

public 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.

Specified by:

containsAll in interface FacetedSearchSearchModel<T>

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

of

public static <T> TermFacetedSearchSearchModel<T> of(String attributePath)

Creates an instance of the search model to generate term faceted search expressions.

Type Parameters:

T - type of the resource

Parameters:

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

Returns:

new instance of TermFacetAndFilterSearchModel

getSearchModel

public SearchModel<T> getSearchModel()

Description copied from interface: FacetedSearchSearchModel

The search model for the faceted search.

Specified by:

getSearchModel in interface FacetedSearchSearchModel<T>

Returns:

the faceted search model