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 Summary

Fields

Modifier and Type	Field	Description
protected String	field
protected long	missing
protected String	name
protected long	other
protected long	total

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSearchFacetResult(String facetName, String field, long total, long missing, long other)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

protected final String name

field

protected final String field

total

protected final long total

missing

protected final long missing

other

protected final long other

Constructor Details

AbstractSearchFacetResult

protected AbstractSearchFacetResult(String facetName,
String field,
long total,
long missing,
long other)

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()).