Class TopGroupsCollector<T>
java.lang.Object
org.apache.lucene.search.SimpleCollector
org.apache.lucene.search.grouping.SecondPassGroupingCollector<T>
org.apache.lucene.search.grouping.TopGroupsCollector<T>
- Type Parameters:
T
- the type of the group value
- All Implemented Interfaces:
Collector
,LeafCollector
A second-pass collector that collects the TopDocs for each group, and returns them as a
TopGroups
object-
Field Summary
Fields inherited from class org.apache.lucene.search.grouping.SecondPassGroupingCollector
groupReducer, groups, groupSelector, totalGroupedHitCount, totalHitCount
-
Constructor Summary
ConstructorDescriptionTopGroupsCollector
(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getMaxScores) Create a new TopGroupsCollector -
Method Summary
Modifier and TypeMethodDescriptiongetTopGroups
(int withinGroupOffset) Get the TopGroups recorded by this collectorMethods inherited from class org.apache.lucene.search.grouping.SecondPassGroupingCollector
collect, doSetNextReader, getGroupSelector, scoreMode, setScorer
Methods inherited from class org.apache.lucene.search.SimpleCollector
getLeafCollector
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.search.LeafCollector
collect, competitiveIterator, finish
-
Constructor Details
-
TopGroupsCollector
public TopGroupsCollector(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getMaxScores) Create a new TopGroupsCollector- Parameters:
groupSelector
- the group selector used to define groupsgroups
- the groups to collect TopDocs forgroupSort
- the order in which groups are returnedwithinGroupSort
- the order in which documents are sorted in each groupmaxDocsPerGroup
- the maximum number of docs to collect for each groupgetMaxScores
- if true, record the maximum score for each group
-
-
Method Details
-
getTopGroups
Get the TopGroups recorded by this collector- Parameters:
withinGroupOffset
- the offset within each group to start collecting documents
-