Module org.apache.lucene.grouping

Package org.apache.lucene.search.grouping

Class FirstPassGroupingCollector<T>

java.lang.Object

org.apache.lucene.search.SimpleCollector

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

All Implemented Interfaces:

Collector, LeafCollector

public class FirstPassGroupingCollector<T>
extends SimpleCollector

FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits. This pass gathers the top N sorted groups. Groups are defined by a GroupSelector

See org.apache.lucene.search.grouping for more details including a full code example.

Field Summary

Fields

Modifier and Type	Field	Description
private final FieldComparator<?>[]	comparators
private final int	compIDXEnd
private int	docBase
private final HashMap<T,CollectedSearchGroup<T>>	groupMap
private final GroupSelector<T>	groupSelector
private final LeafFieldComparator[]	leafComparators
private final boolean	needsScores
protected TreeSet<CollectedSearchGroup<T>>	orderedGroups
private final int[]	reversed
private int	spareSlot
private final int	topNGroups

Constructor Summary

Constructors

Constructor	Description
FirstPassGroupingCollector(GroupSelector<T> groupSelector, Sort groupSort, int topNGroups)	Create the first pass collector.

Method Summary

Modifier and Type	Method	Description
private void	buildSortedSet()
void	collect(int doc)	Called once for every document matching a query, with the unbased document number.
protected void	doSetNextReader(LeafReaderContext readerContext)	This method is called before collecting context.
GroupSelector<T>	getGroupSelector()
Collection<SearchGroup<T>>	getTopGroups(int groupOffset)	Returns top groups, starting from offset.
private boolean	isCompetitive(int doc)
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
void	setScorer(Scorable scorer)	Called before successive calls to LeafCollector.collect(int).

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

collect, competitiveIterator, finish

Field Details

groupSelector

private final GroupSelector<T> groupSelector

comparators

private final FieldComparator<?>[] comparators

leafComparators

private final LeafFieldComparator[] leafComparators

reversed

private final int[] reversed

topNGroups

private final int topNGroups

needsScores

private final boolean needsScores

groupMap

private final HashMap<T,CollectedSearchGroup<T>> groupMap

compIDXEnd

private final int compIDXEnd

orderedGroups

protected TreeSet<CollectedSearchGroup<T>> orderedGroups

docBase

private int docBase

spareSlot

private int spareSlot

Constructor Details

FirstPassGroupingCollector

public FirstPassGroupingCollector(GroupSelector<T> groupSelector,
 Sort groupSort,
 int topNGroups)

Create the first pass collector.

Parameters:

groupSelector - a GroupSelector used to defined groups

groupSort - The Sort used to sort the groups. The top sorted document within each group according to groupSort, determines how that group sorts against other groups. This must be non-null, ie, if you want to groupSort by relevance use Sort.RELEVANCE.

topNGroups - How many top groups to keep.

Method Details

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.

getTopGroups

public Collection<SearchGroup<T>> getTopGroups(int groupOffset)
                                        throws IOException

Returns top groups, starting from offset. This may return null, if no groups were collected, or if the number of unique groups collected is <= offset.

Parameters:

groupOffset - The offset in the collected groups

Returns:

top groups, starting from offset

Throws:

IOException

setScorer

public void setScorer(Scorable scorer)
               throws IOException

Description copied from interface: LeafCollector

Called before successive calls to LeafCollector.collect(int). Implementations that need the score of the current document (passed-in to LeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Specified by:

setScorer in interface LeafCollector

Overrides:

setScorer in class SimpleCollector

Throws:

IOException

isCompetitive

private boolean isCompetitive(int doc)
                       throws IOException

Throws:

IOException

collect

public void collect(int doc)
             throws IOException

Description copied from interface: LeafCollector

Called once for every document matching a query, with the unbased document number.

Note: The collection of the current segment can be terminated by throwing a CollectionTerminatedException. In this case, the last docs of the current LeafReaderContext will be skipped and IndexSearcher will swallow the exception and continue collection with the next leaf.

Note: This is called in an inner search loop. For good search performance, implementations of this method should not call StoredFields.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Specified by:

collect in interface LeafCollector

Specified by:

collect in class SimpleCollector

Throws:

IOException

buildSortedSet

private void buildSortedSet()
                     throws IOException

Throws:

IOException

doSetNextReader

protected void doSetNextReader(LeafReaderContext readerContext)
                        throws IOException

Description copied from class: SimpleCollector

This method is called before collecting context.

Overrides:

doSetNextReader in class SimpleCollector

Throws:

IOException

getGroupSelector

public GroupSelector<T> getGroupSelector()

Returns:

the GroupSelector used for this Collector