io.sphere.sdk.search.model

Interface TermFacetSearchModel<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Superinterfaces:

FacetSearchModel<T,V>

All Known Subinterfaces:

ProductCategoriesIdTermFacetSearchModel<T>

All Known Implementing Classes:

TermFacetSearchModelImpl

public interface TermFacetSearchModel<T,V>
extends FacetSearchModel<T,V>

Model to build term facets.

Method Summary

Modifier and Type	Method and Description
static <T,V> TermFacetSearchModel<T,V>	of(String attributePath, Function<V,String> typeSerializer) Creates an instance of the search model to generate term facet expressions.
FilteredFacetExpression<T>	onlyTerm(Iterable<V> values) Generates an expression to obtain the facets of the attribute for only the given values.
FilteredFacetExpression<T>	onlyTerm(V value) Generates an expression to obtain the facet of the attribute for only the given value.
FilteredFacetExpression<T>	onlyTermAsString(Iterable<String> values) Generates an expression to obtain the facets of the attribute for only the given values.
TermFacetSearchModel<T,V>	withAlias(String alias) Allows to set an alias to identify the facet.
TermFacetSearchModel<T,V>	withCountingProducts(Boolean isCountingProducts) Allows to enable/disable the counting of products.

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

allTerms, getAlias, getSearchModel, isCountingProducts

Method Detail

onlyTerm

FilteredFacetExpression<T> onlyTerm(V value)

Description copied from interface: FacetSearchModel

Generates an expression to obtain the facet of the attribute for only the given value. For example: a possible faceted classification for "red" could be ["red": 4].

Specified by:

onlyTerm in interface FacetSearchModel<T,V>

Parameters:

value - the value from which to obtain the facet

Returns:

a facet expression for only the given value

onlyTerm

FilteredFacetExpression<T> onlyTerm(Iterable<V> values)

Description copied from interface: FacetSearchModel

Generates an expression to obtain the facets of the attribute for only the given values. For example: a possible faceted classification for ["red", "blue"] could be ["red": 4, "blue": 1].

Specified by:

onlyTerm in interface FacetSearchModel<T,V>

Parameters:

values - the values from which to obtain the facets

Returns:

a facet expression for only the given values

onlyTermAsString

FilteredFacetExpression<T> onlyTermAsString(Iterable<String> values)

Description copied from interface: FacetSearchModel

Generates an expression to obtain the facets of the attribute for only the given values. For example: a possible faceted classification for ["red", "blue"] could be ["red": 4, "blue": 1].

Specified by:

onlyTermAsString in interface FacetSearchModel<T,V>

Parameters:

values - the values from which to obtain the facets

Returns:

a facet expression for only the given values

withAlias

TermFacetSearchModel<T,V> withAlias(String alias)

Description copied from interface: FacetSearchModel

Allows to set an alias to identify the facet.

Specified by:

withAlias in interface FacetSearchModel<T,V>

Parameters:

alias - the identifier to use for the facet

Returns:

a new facet search model identical to the current one, but with the given alias

withCountingProducts

TermFacetSearchModel<T,V> withCountingProducts(Boolean isCountingProducts)

Description copied from interface: FacetSearchModel

Allows to enable/disable the counting of products.

Specified by:

withCountingProducts in interface FacetSearchModel<T,V>

Parameters:

isCountingProducts - whether to count products or not

Returns:

a new facet search model identical to the current one, but with the counting of products enabled/disabled

of

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

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

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 TermFacetSearchModel