io.sphere.sdk.search

Interface FacetExpression<T>

Type Parameters:

T - Type of the resource for the facet

All Superinterfaces:

SearchExpression<T>

All Known Subinterfaces:

FilteredFacetExpression<T>, RangeFacetExpression<T>, TermFacetExpression<T>

public interface FacetExpression<T>
extends SearchExpression<T>

Facets calculate statistical counts to aid in faceted navigation. Example: variants.attributes.color:"green","yellow"

See Also:

FacetSearchModel

Method Summary

Modifier and Type	Method and Description
String	alias() Gets the defined alias.
String	resultPath() Gets the path of the facet result, which is either the alias or the search path if no alias defined.

Methods inherited from interface io.sphere.sdk.search.SearchExpression

attributePath, expression, value

Method Detail

resultPath

String resultPath()

Gets the path of the facet result, which is either the alias or the search path if no alias defined. Example: variants.attributes.color

Returns:

the path to access the facet result

alias

@Nullable
String alias()

Gets the defined alias.

Returns:

the alias of the facet