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

Interface FacetResult

All Known Subinterfaces:
DateRangeFacetResult, NumericRangeFacetResult, TermFacetResult
All Known Implementing Classes:
AbstractFacetResult, DefaultDateRangeFacetResult, DefaultNumericRangeFacetResult, DefaultTermFacetResult
@Experimental
@Public
public interface FacetResult
Base interface for all facet results.
Since:
2.3.0
Author:
Simon Baslé, Michael Nitschinger

  • Method Details

    • name

      String name()
      Returns:
      the name of the SearchFacet this result corresponds to.

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