io.sphere.sdk.search

Class TermFacetResult

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.TermFacetResult

All Implemented Interfaces:

FacetResult

public final class TermFacetResult
extends Base
implements FacetResult

Method Summary

Modifier and Type	Method and Description
Long	getMissing() The number of resources which have no value for the corresponding field.
Long	getOther() The number of resources not included in the returned list of terms.
List<TermStats>	getTerms() List of the different terms and amount of associated resources.
Long	getTotal() The number of resources matching some term in the facet.
static TermFacetResult	of(Long missing, Long total, Long other, List<TermStats> terms)

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

Method Detail

getMissing

public Long getMissing()

The number of resources which have no value for the corresponding field. Use case: in a product search where a term facet is requested for a color attribute, it would represent the amount of variants with no color associated.

Returns:

amount of resources missing a value for the faceted field.

getTotal

public Long getTotal()

The number of resources matching some term in the facet.

Returns:

amount of resources that match at least one term in the facet.

getOther

public Long getOther()

The number of resources not included in the returned list of terms.

Returns:

amount of resources matching the terms that could not be included in the facet result.

getTerms

public List<TermStats> getTerms()

List of the different terms and amount of associated resources.

Returns:

the list of distinct terms aLong with the number of matching resources.

of

public static TermFacetResult of(Long missing,
                                 Long total,
                                 Long other,
                                 List<TermStats> terms)