io.sphere.sdk.search.model

Class TermFacetSearchModelImpl<T,V>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.TermFacetSearchModelImpl<T,V>

Type Parameters:

T - type of the resource

V - type of the value

All Implemented Interfaces:

FacetSearchModel<T,V>, TermFacetSearchModel<T,V>

public class TermFacetSearchModelImpl<T,V>
extends Base
implements TermFacetSearchModel<T,V>

Model to build term facets.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alias
protected Boolean	isCountingProducts
protected SearchModel<T>	searchModel
protected Function<V,String>	typeSerializer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TermFacetSearchModelImpl(SearchModel<T> searchModel, Function<V,String> typeSerializer)
protected	TermFacetSearchModelImpl(SearchModel<T> searchModel, Function<V,String> typeSerializer, String alias, Boolean isCountingProducts)

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.
static <T,V> TermFacetSearchModelImpl<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 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.TermFacetSearchModel

onlyTermAsString

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

getAlias, getSearchModel, isCountingProducts

Field Detail

searchModel

protected final SearchModel<T> searchModel

typeSerializer

protected final Function<V,String> typeSerializer

alias

@Nullable
protected final String alias

isCountingProducts

protected final Boolean isCountingProducts

Constructor Detail

TermFacetSearchModelImpl

protected TermFacetSearchModelImpl(SearchModel<T> searchModel,
                                   Function<V,String> typeSerializer,
                                   String alias,
                                   Boolean isCountingProducts)

TermFacetSearchModelImpl

protected TermFacetSearchModelImpl(SearchModel<T> searchModel,
                                   Function<V,String> typeSerializer)

Method Detail

withAlias

public TermFacetSearchModel<T,V> withAlias(String alias)

Allows to set an alias to identify the facet.

Specified by:

withAlias in interface FacetSearchModel<T,V>

Specified by:

withAlias in interface TermFacetSearchModel<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

public TermFacetSearchModel<T,V> withCountingProducts(Boolean isCountingProducts)

Allows to enable/disable the counting of products.

Specified by:

withCountingProducts in interface FacetSearchModel<T,V>

Specified by:

withCountingProducts in interface TermFacetSearchModel<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

allTerms

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

Specified by:

allTerms in interface FacetSearchModel<T,V>

Returns:

a facet expression for all values

onlyTerm

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

Specified by:

onlyTerm in interface FacetSearchModel<T,V>

Specified by:

onlyTerm in interface TermFacetSearchModel<T,V>

Parameters:

value - the value from which to obtain the facet

Returns:

a facet expression for only the given value

onlyTerm

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

Specified by:

onlyTerm in interface FacetSearchModel<T,V>

Specified by:

onlyTerm in interface TermFacetSearchModel<T,V>

Parameters:

values - the values from which to obtain the facets

Returns:

a facet expression for only the given values

of

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

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

Specified by:

of in interface TermFacetSearchModel<T,V>

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

getAlias

@Nullable
public String getAlias()

The alias related to the facet.

Specified by:

getAlias in interface FacetSearchModel<T,V>

Returns:

the facet alias

isCountingProducts

public Boolean isCountingProducts()

Whether the facet is counting products.

Specified by:

isCountingProducts in interface FacetSearchModel<T,V>

Returns:

whether the facet is counting products

getSearchModel

public SearchModel<T> getSearchModel()

Description copied from interface: FacetSearchModel

The search model for the facet.

Specified by:

getSearchModel in interface FacetSearchModel<T,V>

Returns:

the facet search model

onlyTermAsString

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

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