Module org.apache.lucene.core

Package org.apache.lucene.search

Class TopFieldCollector.TopFieldLeafCollector

java.lang.Object

org.apache.lucene.search.TopFieldCollector.TopFieldLeafCollector

All Implemented Interfaces:

LeafCollector

Enclosing class:

TopFieldCollector

private abstract class TopFieldCollector.TopFieldLeafCollector
extends Object
implements LeafCollector

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	collectedAllCompetitiveHits
(package private) final LeafFieldComparator	comparator
(package private) final int	reverseMul
(package private) Scorable	scorer

Constructor Summary

Constructors

Constructor	Description
TopFieldLeafCollector(FieldValueHitQueue<FieldValueHitQueue.Entry> queue, Sort sort, LeafReaderContext context)

Method Summary

Modifier and Type	Method	Description
(package private) void	collectAnyHit(int doc, int hitsCollected)
(package private) void	collectCompetitiveHit(int doc)
DocIdSetIterator	competitiveIterator()	Optionally returns an iterator over competitive documents.
(package private) void	countHit(int doc)
void	setScorer(Scorable scorer)	Called before successive calls to LeafCollector.collect(int).
(package private) boolean	thresholdCheck(int doc)

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, collect, finish

Field Details

comparator

final LeafFieldComparator comparator

reverseMul

final int reverseMul

scorer

Scorable scorer

collectedAllCompetitiveHits

boolean collectedAllCompetitiveHits

Constructor Details

TopFieldLeafCollector

TopFieldLeafCollector(FieldValueHitQueue<FieldValueHitQueue.Entry> queue,
 Sort sort,
 LeafReaderContext context)
               throws IOException

Throws:

IOException

Method Details

countHit

void countHit(int doc)
       throws IOException

Throws:

IOException

thresholdCheck

boolean thresholdCheck(int doc)
                throws IOException

Throws:

IOException

collectCompetitiveHit

void collectCompetitiveHit(int doc)
                    throws IOException

Throws:

IOException

collectAnyHit

void collectAnyHit(int doc,
 int hitsCollected)
            throws IOException

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

Throws:

IOException

competitiveIterator

public DocIdSetIterator competitiveIterator()
                                     throws IOException

Description copied from interface: LeafCollector

Optionally returns an iterator over competitive documents.

Collectors should delegate this method to their comparators if their comparators provide the skipping functionality over non-competitive docs.

The default is to return null which is interpreted as the collector provide any competitive iterator.

Specified by:

competitiveIterator in interface LeafCollector

Throws:

IOException