io.sphere.sdk.search.model

Interface FacetSearchModel<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Known Subinterfaces:

ProductCategoriesIdTermFacetSearchModel<T>, TermFacetSearchModel<T,V>

All Known Implementing Classes:

RangeTermFacetSearchModel, TermFacetSearchModelImpl

public interface FacetSearchModel<T,V>

Model to build facets.

Method Summary

Modifier and Type	Method and Description
TermFacetExpression<T>	allTerms() Generates an expression to obtain the facets of the attribute for all values.
String	getAlias() The alias related to the facet.
SearchModel<T>	getSearchModel() The search model for the facet.
Boolean	isCountingProducts() Whether the facet is counting products.
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.
FacetSearchModel<T,V>	withAlias(String alias) Allows to set an alias to identify the facet.
FacetSearchModel<T,V>	withCountingProducts(Boolean isCountingProducts) Allows to enable/disable the counting of products.

Method Detail

getSearchModel

SearchModel<T> getSearchModel()

The search model for the facet.

Returns:

the facet search model

getAlias

@Nullable
String getAlias()

The alias related to the facet.

Returns:

the facet alias

isCountingProducts

@Nullable
Boolean isCountingProducts()

Whether the facet is counting products.

Returns:

whether the facet is counting products

withAlias

FacetSearchModel<T,V> withAlias(String alias)

Allows to set an alias to identify the facet.

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

FacetSearchModel<T,V> withCountingProducts(Boolean isCountingProducts)

Allows to enable/disable the counting of products.

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

allTerms

TermFacetExpression<T> allTerms()

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

Returns:

a facet expression for all values

onlyTerm

FilteredFacetExpression<T> onlyTerm(V value)

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

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)

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

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)

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

Parameters:

values - the values from which to obtain the facets

Returns:

a facet expression for only the given values