Class HitCollector

  extended by
Direct Known Subclasses:
TimeLimitedCollector, TopDocCollector

Deprecated. Please use Collector instead.

public abstract class HitCollector
extends Object

Lower-level search API.
HitCollectors are primarily meant to be used to implement queries, sorting and filtering. See Collector for a lower level and higher performance (on a multi-segment index) API.

$Id: 764551 2009-04-13 18:33:56Z mikemccand $
See Also:,HitCollector)

Constructor Summary
Method Summary
abstract  void collect(int doc, float score)
          Deprecated. Called once for every document matching a query, with the document number and its raw score.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public HitCollector()
Method Detail


public abstract void collect(int doc,
                             float score)
Called once for every document matching a query, with the document number and its raw score.

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

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

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.

Note: The score passed to this method is a raw score. In other words, the score will not necessarily be a float whose value is between 0 and 1.

Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.