Package com.couchbase.client.java.search.result

Interface SearchFacetResult

All Known Implementing Classes:

AbstractSearchFacetResult, DateRangeSearchFacetResult, NumericRangeSearchFacetResult, TermSearchFacetResult

public interface SearchFacetResult

Base interface for all facet results.

Since:

2.3.0

Method Summary

Modifier and Type	Method	Description
String	field()
long	missing()
String	name()
long	other()
long	total()

Method Details

name

String name()

Returns:

the name of the facet.

field

String field()

Returns:

the field the SearchFacet was targeting.

total

long total()

Returns:

the total number of *valued* facet results. Total = other() + terms (but doesn't include missing()).

missing

long missing()

Returns:

the number of results that couldn't be faceted, missing the adequate value. Not matter how many more buckets are added to the original facet, these result won't ever be included in one.

other

long other()

Returns:

the number of results that could have been faceted (because they have a value for the facet's field) but weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.