Package org.apache.lucene.search.grouping

Class GroupedFacetResult

java.lang.Object

org.apache.lucene.search.grouping.GroupedFacetResult

public class GroupedFacetResult
extends Object

The grouped facet result. Containing grouped facet entries, total count and total missing count.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GroupedFacetResult.FacetEntry	Represents a facet entry with a value and a count.

Method Summary

Modifier and Type	Method	Description
List<GroupedFacetResult.FacetEntry>	getFacetEntries(int offset, int limit)	Returns a list of facet entries to be rendered based on the specified offset and limit.
int	getTotalCount()	Returns the sum of all facet entries counts.
int	getTotalMissingCount()	Returns the number of groups that didn't have a facet value.

Methods inherited from class java.lang.Object

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

Method Details

getFacetEntries

public List<GroupedFacetResult.FacetEntry> getFacetEntries(int offset,
 int limit)

Returns a list of facet entries to be rendered based on the specified offset and limit. The facet entries are retrieved from the facet entries collected during merging.

Parameters:

offset - The offset in the collected facet entries during merging

limit - The number of facets to return starting from the offset.

Returns:

a list of facet entries to be rendered based on the specified offset and limit

getTotalCount

public int getTotalCount()

Returns the sum of all facet entries counts.

Returns:

the sum of all facet entries counts

getTotalMissingCount

public int getTotalMissingCount()

Returns the number of groups that didn't have a facet value.

Returns:

the number of groups that didn't have a facet value