org.apache.lucene.search.grouping.term

Class TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector

java.lang.Object

org.apache.lucene.search.SimpleCollector

org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector<GH>

org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector<TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead>

org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector

All Implemented Interfaces:

Collector, LeafCollector

Enclosing class:

TermAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead<?>>

static class TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector
extends TermAllGroupHeadsCollector<TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead

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

TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector, TermAllGroupHeadsCollector.OrdAllGroupHeadsCollector, TermAllGroupHeadsCollector.OrdScoreAllGroupHeadsCollector, TermAllGroupHeadsCollector.ScoreAllGroupHeadsCollector

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

AbstractAllGroupHeadsCollector.TemporalResult

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<BytesRef,TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead>	groups
(package private) Scorer	scorer
private Sort	sortWithinGroup

Fields inherited from class org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector

groupField, groupIndex, readerContext

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

compIDXEnd, reversed, temporalResult

Constructor Summary

Constructors

Constructor and Description
GeneralAllGroupHeadsCollector(java.lang.String groupField, Sort sortWithinGroup)

Method Summary

Modifier and Type	Method and Description
protected void	doSetNextReader(LeafReaderContext context) This method is called before collecting context.
protected java.util.Collection<TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead>	getCollectedGroupHeads() Returns the collected group heads.
boolean	needsScores() Indicates if document scores are needed by this collector.
protected void	retrieveGroupHeadAndAddIfNotExist(int doc) Returns the group head and puts it into AbstractAllGroupHeadsCollector.temporalResult.
void	setScorer(Scorer scorer) Called before successive calls to LeafCollector.collect(int).

Methods inherited from class org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector

create, create

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

collect, groupHeadsSize, retrieveGroupHeads, retrieveGroupHeads

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

sortWithinGroup

private final Sort sortWithinGroup

groups

private final java.util.Map<BytesRef,TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead> groups

scorer

Scorer scorer

Constructor Detail

GeneralAllGroupHeadsCollector

GeneralAllGroupHeadsCollector(java.lang.String groupField,
                              Sort sortWithinGroup)

Method Detail

retrieveGroupHeadAndAddIfNotExist

protected void retrieveGroupHeadAndAddIfNotExist(int doc)
                                          throws java.io.IOException

Description copied from class: AbstractAllGroupHeadsCollector

Returns the group head and puts it into AbstractAllGroupHeadsCollector.temporalResult. If the group head wasn't encountered before then it will be added to the collected group heads.

The AbstractAllGroupHeadsCollector.TemporalResult.stop property will be true if the group head wasn't encountered before otherwise false.

Specified by:

retrieveGroupHeadAndAddIfNotExist in class AbstractAllGroupHeadsCollector<TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead>

Parameters:

doc - The document to retrieve the group head for.

Throws:

java.io.IOException - If I/O related errors occur

getCollectedGroupHeads

protected java.util.Collection<TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead> getCollectedGroupHeads()

Description copied from class: AbstractAllGroupHeadsCollector

Returns the collected group heads. Subsequent calls should return the same group heads.

Specified by:

getCollectedGroupHeads in class AbstractAllGroupHeadsCollector<TermAllGroupHeadsCollector.GeneralAllGroupHeadsCollector.GroupHead>

Returns:

the collected group heads

doSetNextReader

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

Description copied from class: SimpleCollector

This method is called before collecting context.

Overrides:

doSetNextReader in class SimpleCollector

Throws:

java.io.IOException

needsScores

public boolean needsScores()

Description copied from interface: Collector

Indicates if document scores are needed by this collector.

Returns:

true if scores are needed.

setScorer

public void setScorer(Scorer scorer)
               throws java.io.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:

java.io.IOException