Package org.apache.lucene.search.grouping

Class GroupFacetCollector.GroupedFacetResult

java.lang.Object

org.apache.lucene.search.grouping.GroupFacetCollector.GroupedFacetResult

Enclosing class:

GroupFacetCollector

public static class GroupFacetCollector.GroupedFacetResult
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private int	currentMin
private java.util.NavigableSet<GroupFacetCollector.FacetEntry>	facetEntries
private int	maxSize
private static java.util.Comparator<GroupFacetCollector.FacetEntry>	orderByCountAndValue
private static java.util.Comparator<GroupFacetCollector.FacetEntry>	orderByValue
private int	totalCount
private int	totalMissingCount

Constructor Summary

Constructors

Constructor	Description
GroupedFacetResult(int size, int minCount, boolean orderByCount, int totalCount, int totalMissingCount)

Method Summary

Modifier and Type	Method	Description
void	addFacetCount(BytesRef facetValue, int count)
java.util.List<GroupFacetCollector.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

Field Detail

orderByCountAndValue

private static final java.util.Comparator<GroupFacetCollector.FacetEntry> orderByCountAndValue

orderByValue

private static final java.util.Comparator<GroupFacetCollector.FacetEntry> orderByValue

maxSize

private final int maxSize

facetEntries

private final java.util.NavigableSet<GroupFacetCollector.FacetEntry> facetEntries

totalMissingCount

private final int totalMissingCount

totalCount

private final int totalCount

currentMin

private int currentMin

Constructor Detail

GroupedFacetResult

public GroupedFacetResult(int size,
                          int minCount,
                          boolean orderByCount,
                          int totalCount,
                          int totalMissingCount)

Method Detail

addFacetCount

public void addFacetCount(BytesRef facetValue,
                          int count)

getFacetEntries

public java.util.List<GroupFacetCollector.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