org.apache.lucene.search.grouping
Class TopGroups

java.lang.Object
  org.apache.lucene.search.grouping.TopGroups

public class TopGroups
extends Object

Represents result returned by a grouping search.

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

Field Summary

GroupDocs[]	groups Group results in groupSort order
org.apache.lucene.search.SortField[]	groupSort How groups are sorted against each other
Integer	totalGroupCount The total number of unique groups.
int	totalGroupedHitCount Number of documents grouped into the topN groups
int	totalHitCount Number of documents matching the search
org.apache.lucene.search.SortField[]	withinGroupSort How docs are sorted within each group

Constructor Summary

TopGroups(org.apache.lucene.search.SortField[] groupSort, org.apache.lucene.search.SortField[] withinGroupSort, int totalHitCount, int totalGroupedHitCount, GroupDocs[] groups)

TopGroups(TopGroups oldTopGroups, Integer totalGroupCount)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

totalHitCount

public final int totalHitCount

Number of documents matching the search

totalGroupedHitCount

public final int totalGroupedHitCount

Number of documents grouped into the topN groups

totalGroupCount

public final Integer totalGroupCount

The total number of unique groups. If null this value is not computed.

groups

public final GroupDocs[] groups

Group results in groupSort order

groupSort

public final org.apache.lucene.search.SortField[] groupSort

How groups are sorted against each other

withinGroupSort

public final org.apache.lucene.search.SortField[] withinGroupSort

How docs are sorted within each group

Constructor Detail

TopGroups

public TopGroups(org.apache.lucene.search.SortField[] groupSort,
                 org.apache.lucene.search.SortField[] withinGroupSort,
                 int totalHitCount,
                 int totalGroupedHitCount,
                 GroupDocs[] groups)

TopGroups

public TopGroups(TopGroups oldTopGroups,
                 Integer totalGroupCount)