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

Class AbstractSearchFacetResult

java.lang.Object
com.couchbase.client.java.search.result.AbstractSearchFacetResult
All Implemented Interfaces:
SearchFacetResult
Direct Known Subclasses:
DateRangeSearchFacetResult, NumericRangeSearchFacetResult, TermSearchFacetResult
public abstract class AbstractSearchFacetResult extends Object implements SearchFacetResult

  • Field Details

    • internal

      protected final com.couchbase.client.core.api.search.result.CoreAbstractSearchFacetResult internal

  • Constructor Details

    • AbstractSearchFacetResult

      protected AbstractSearchFacetResult(com.couchbase.client.core.api.search.result.CoreAbstractSearchFacetResult internal)

  • Method Details

    • name

      public String name()
      Specified by:
      name in interface SearchFacetResult
      Returns:
      the name of the facet.

    • field

      public String field()
      Specified by:
      field in interface SearchFacetResult
      Returns:
      the field the SearchFacet was targeting.

    • missing

      public long missing()
      Specified by:
      missing in interface SearchFacetResult
      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

      public long other()
      Specified by:
      other in interface SearchFacetResult
      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.

    • total

      public long total()
      Specified by:
      total in interface SearchFacetResult
      Returns:
      the total number of *valued* facet results. Total = SearchFacetResult.other() + terms (but doesn't include SearchFacetResult.missing()).