org.apache.lucene.search.grouping.term

Class TermSecondPassGroupingCollector

java.lang.Object

org.apache.lucene.search.SimpleCollector

org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector<BytesRef>

org.apache.lucene.search.grouping.term.TermSecondPassGroupingCollector

All Implemented Interfaces:

Collector, LeafCollector

public class TermSecondPassGroupingCollector
extends AbstractSecondPassGroupingCollector<BytesRef>

Concrete implementation of AbstractSecondPassGroupingCollector that groups based on field values and more specifically uses SortedDocValues to collect grouped docs.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector

AbstractSecondPassGroupingCollector.SearchGroupDocs<GROUP_VALUE_TYPE>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	groupField
private SortedDocValues	index
private SentinelIntSet	ordSet

Fields inherited from class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector

groupDocs, groupMap

Constructor Summary

Constructors

Constructor and Description
TermSecondPassGroupingCollector(java.lang.String groupField, java.util.Collection<SearchGroup<BytesRef>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getScores, boolean getMaxScores, boolean fillSortFields)

Method Summary

Modifier and Type	Method and Description
protected void	doSetNextReader(LeafReaderContext readerContext) This method is called before collecting context.
protected AbstractSecondPassGroupingCollector.SearchGroupDocs<BytesRef>	retrieveGroup(int doc) Returns the group the specified doc belongs to or null if no group could be retrieved.

Methods inherited from class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector

collect, getTopGroups, needsScores, 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

Field Detail

groupField

private final java.lang.String groupField

ordSet

private final SentinelIntSet ordSet

index

private SortedDocValues index

Constructor Detail

TermSecondPassGroupingCollector

public TermSecondPassGroupingCollector(java.lang.String groupField,
                                       java.util.Collection<SearchGroup<BytesRef>> groups,
                                       Sort groupSort,
                                       Sort withinGroupSort,
                                       int maxDocsPerGroup,
                                       boolean getScores,
                                       boolean getMaxScores,
                                       boolean fillSortFields)
                                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

doSetNextReader

protected void doSetNextReader(LeafReaderContext readerContext)
                        throws java.io.IOException

Description copied from class: SimpleCollector

This method is called before collecting context.

Overrides:

doSetNextReader in class AbstractSecondPassGroupingCollector<BytesRef>

Throws:

java.io.IOException

retrieveGroup

protected AbstractSecondPassGroupingCollector.SearchGroupDocs<BytesRef> retrieveGroup(int doc)
                                                                               throws java.io.IOException

Description copied from class: AbstractSecondPassGroupingCollector

Returns the group the specified doc belongs to or null if no group could be retrieved.

Specified by:

retrieveGroup in class AbstractSecondPassGroupingCollector<BytesRef>

Parameters:

doc - The specified doc

Returns:

the group the specified doc belongs to or null if no group could be retrieved

Throws:

java.io.IOException - If an I/O related error occurred