org.apache.lucene.search
Class HitCollector

java.lang.Object
  |
  +--org.apache.lucene.search.HitCollector

public abstract class HitCollector

extends Object

Lower-level search API.

See Also:

Searcher.search(Query,HitCollector)

Constructor Summary

HitCollector()

Method Summary

abstract void

collect(int doc, float score) Called once for every non-zero scoring document, with the document number and its score.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HitCollector

public HitCollector()

Method Detail

collect

public abstract void collect(int doc,
                             float score)

Called once for every non-zero scoring document, with the document number and its score.

If, for example, an application wished to collect all of the hits for a query in a BitSet, then it might:

   Searcher = new IndexSearcher(indexReader);
   final BitSet bits = new BitSet(indexReader.maxDoc());
   searcher.search(query, new HitCollector() {
       public void collect(int doc, float score) {
         bits.set(doc);
       }
     });
 

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