public class

PositiveScoresOnlyCollector

extends Collector
java.lang.Object
   ↳ org.apache.lucene.search.Collector
     ↳ org.apache.lucene.search.PositiveScoresOnlyCollector

Class Overview

A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected.

Summary

Public Constructors
PositiveScoresOnlyCollector(Collector c)
Public Methods
boolean acceptsDocsOutOfOrder()
Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to collect(int).
void collect(int doc)
Called once for every document matching a query, with the unbased document number.
void setNextReader(IndexReader reader, int docBase)
Called before collecting from each IndexReader.
void setScorer(Scorer scorer)
Called before successive calls to collect(int).
[Expand]
Inherited Methods
From class org.apache.lucene.search.Collector
From class java.lang.Object

Public Constructors

public PositiveScoresOnlyCollector (Collector c)

Public Methods

public boolean acceptsDocsOutOfOrder ()

Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to collect(int).

Most Lucene Query implementations will visit matching docIDs in order. However, some queries (currently limited to certain cases of BooleanQuery) can achieve faster searching if the Collector allows them to deliver the docIDs out of order.

Many collectors don't mind getting docIDs out of order, so it's important to return true here.

public void collect (int doc)

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

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

Throws
IOException

public void setNextReader (IndexReader reader, int docBase)

Called before collecting from each IndexReader. All doc ids in collect(int) will correspond to reader. Add docBase to the current IndexReaders internal document id to re-base ids in collect(int).

Parameters
reader next IndexReader
Throws
IOException

public void setScorer (Scorer scorer)

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

Throws
IOException