## Uses of Class
org.apache.lucene.search.grouping.TopGroups

Packages that use TopGroups
Package | Description
--- | ---
org.apache.lucene.search.grouping | This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.

### Uses of TopGroups in org.apache.lucene.search.grouping

Methods in org.apache.lucene.search.grouping that return TopGroups
Modifier and Type | Method and Description
--- | ---
`TopGroups<GROUP_VALUE_TYPE>` | AbstractSecondPassGroupingCollector.`getTopGroups(int withinGroupOffset)`
`TopGroups<?>` | BlockGroupingCollector.`getTopGroups(Sort withinGroupSort, int groupOffset, int withinGroupOffset, int maxDocsPerGroup, boolean fillSortFields)` Returns the grouped results.
`protected TopGroups<?>` | GroupingSearch.`groupByDocBlock(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)`
`protected TopGroups` | GroupingSearch.`groupByFieldOrFunction(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)`
`static <T> TopGroups<T>` | TopGroups.`merge(TopGroups<T>[] shardGroups, Sort groupSort, Sort docSort, int docOffset, int docTopN, TopGroups.ScoreMergeMode scoreMergeMode)` Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.
`<T> TopGroups<T>` | GroupingSearch.`search(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)` Executes a grouped search.
`<T> TopGroups<T>` | GroupingSearch.`search(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)` Executes a grouped search.

Methods in org.apache.lucene.search.grouping with parameters of type TopGroups
Modifier and Type | Method and Description
--- | ---
`static <T> TopGroups<T>` | TopGroups.`merge(TopGroups<T>[] shardGroups, Sort groupSort, Sort docSort, int docOffset, int docTopN, TopGroups.ScoreMergeMode scoreMergeMode)` Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.

Constructors in org.apache.lucene.search.grouping with parameters of type TopGroups
Constructor and Description
`TopGroups(TopGroups<GROUP_VALUE_TYPE> oldTopGroups, Integer totalGroupCount)`