Package org.apache.lucene.search.grouping

Class SecondPassGroupingCollector<T>

java.lang.Object

org.apache.lucene.search.SimpleCollector

org.apache.lucene.search.grouping.SecondPassGroupingCollector<T>

All Implemented Interfaces:

org.apache.lucene.search.Collector, org.apache.lucene.search.LeafCollector

Direct Known Subclasses:

DistinctValuesCollector, TopGroupsCollector

public class SecondPassGroupingCollector<T>
extends org.apache.lucene.search.SimpleCollector

SecondPassGroupingCollector runs over an already collected set of groups, further applying a GroupReducer to each group

See Also:

• TopGroupsCollector
• DistinctValuesCollector

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final GroupReducer<T,?>	groupReducer
protected final Collection<SearchGroup<T>>	groups
protected final GroupSelector<T>	groupSelector
protected int	totalGroupedHitCount
protected int	totalHitCount

Constructor Summary

Constructors

Constructor	Description
SecondPassGroupingCollector(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, GroupReducer<T,?> reducer)	Create a new SecondPassGroupingCollector

Method Summary

Modifier and Type	Method	Description
void	collect(int doc)
protected void	doSetNextReader(org.apache.lucene.index.LeafReaderContext readerContext)
GroupSelector<T>	getGroupSelector()
org.apache.lucene.search.ScoreMode	scoreMode()
void	setScorer(org.apache.lucene.search.Scorable scorer)

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.Collector

setWeight

Methods inherited from interface org.apache.lucene.search.LeafCollector

competitiveIterator

Field Details

groupSelector

protected final GroupSelector<T> groupSelector

groups

protected final Collection<SearchGroup<T>> groups

groupReducer

protected final GroupReducer<T,?> groupReducer

totalHitCount

protected int totalHitCount

totalGroupedHitCount

protected int totalGroupedHitCount

Constructor Details

SecondPassGroupingCollector

public SecondPassGroupingCollector(GroupSelector<T> groupSelector,
 Collection<SearchGroup<T>> groups,
 GroupReducer<T,?> reducer)

Create a new SecondPassGroupingCollector

Parameters:

groupSelector - the GroupSelector that defines groups for this search

groups - the groups to collect documents for

reducer - the reducer to apply to each group

Method Details

getGroupSelector

public GroupSelector<T> getGroupSelector()

Returns:

the GroupSelector used in this collector

scoreMode

public org.apache.lucene.search.ScoreMode scoreMode()

setScorer

public void setScorer(org.apache.lucene.search.Scorable scorer)
               throws IOException

Specified by:

setScorer in interface org.apache.lucene.search.LeafCollector

Overrides:

setScorer in class org.apache.lucene.search.SimpleCollector

Throws:

IOException

collect

public void collect(int doc)
             throws IOException

Specified by:

collect in interface org.apache.lucene.search.LeafCollector

Specified by:

collect in class org.apache.lucene.search.SimpleCollector

Throws:

IOException

doSetNextReader

protected void doSetNextReader(org.apache.lucene.index.LeafReaderContext readerContext)
                        throws IOException

Overrides:

doSetNextReader in class org.apache.lucene.search.SimpleCollector

Throws:

IOException