org.apache.lucene.search: public final class: Hits

org.apache.lucene.search
public final class: Hits [javadoc | source]

java.lang.Object
   org.apache.lucene.search.Hits

Deprecated! Hits - will be removed in Lucene 3.0.

Instead e. g. TopDocCollector and TopDocs can be used:

TopDocCollector collector = new TopDocCollector(hitsPerPage);
searcher.search(query, collector);
ScoreDoc[] hits = collector.topDocs().scoreDocs;
for (int i = 0; i < hits.length; i++) {
int docId = hits[i].doc;
Document d = searcher.doc(docId);
// do something with current hit
...

A ranked list of documents, used to hold search results.

Caution: Iterate only over the hits needed. Iterating over all hits is generally not desirable and may be the source of performance issues. If you need to iterate over many or all hits, consider using the search method that takes a HitCollector .

Note: Deleting matching documents concurrently with traversing the hits, might, when deleting hits that were not yet retrieved, decrease #length() . In such case, ConcurrentModificationException is thrown when accessing hit n ≥ current_#length() (but n < #length() _at_start).

Field Summary
boolean	debugCheckedForDeletions

Constructor:
Hits(Searcher s, Query q, Filter f) throws IOException { // for test purposes. weight = q.weight(s); searcher = s; filter = f; nDeletions = countDeletions(s); getMoreDocs(50); // retrieve 100 initially lengthAtStart = length; }
Hits(Searcher s, Query q, Filter f, Sort o) throws IOException { weight = q.weight(s); searcher = s; filter = f; sort = o; nDeletions = countDeletions(s); getMoreDocs(50); // retrieve 100 initially lengthAtStart = length; }

Constructor:

 Hits(Searcher s,
    Query q,
    Filter f) throws IOException {
 // for test purposes.
    weight = q.weight(s);
    searcher = s;
    filter = f;
    nDeletions = countDeletions(s);
    getMoreDocs(50); // retrieve 100 initially
    lengthAtStart = length;
}

 Hits(Searcher s,
    Query q,
    Filter f,
    Sort o) throws IOException {
    weight = q.weight(s);
    searcher = s;
    filter = f;
    sort = o;
    nDeletions = countDeletions(s);
    getMoreDocs(50); // retrieve 100 initially
    lengthAtStart = length;
}

Method from org.apache.lucene.search.Hits Summary:
doc, id, iterator, length, score

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.lucene.search.Hits Detail:
public final Document doc(int n) throws IOException, CorruptIndexException { HitDoc hitDoc = hitDoc(n); // Update LRU cache of documents remove(hitDoc); // remove from list, if there addToFront(hitDoc); // add to front of list if (numDocs > maxDocs) { // if cache is full HitDoc oldLast = last; remove(last); // flush last oldLast.doc = null; // let doc get gc'd } if (hitDoc.doc == null) { hitDoc.doc = searcher.doc(hitDoc.id); // cache miss: read document } return hitDoc.doc; } Deprecated! Returns the stored fields of the n^th document in this set. Documents are cached, so that repeated requests for the same element may return the same Document object.
public final int id(int n) throws IOException { return hitDoc(n).id; } Deprecated! Returns the id for the n^th document in this set. Note that ids may change when the index changes, so you cannot rely on the id to be stable.
public Iterator iterator() { return new HitIterator(this); } Deprecated! Returns a HitIterator to navigate the Hits. Each item returned from Iterator#next() is a Hit . Caution: Iterate only over the hits needed. Iterating over all hits is generally not desirable and may be the source of performance issues. If you need to iterate over many or all hits, consider using a search method that takes a HitCollector .
public final int length() { return length; } Deprecated! Returns the total number of hits available in this set.
public final float score(int n) throws IOException { return hitDoc(n).score; } Deprecated! Returns the score for the n^th document in this set.

Method from org.apache.lucene.search.Hits Detail:

 public final Document doc(int n) throws IOException, CorruptIndexException {
    HitDoc hitDoc = hitDoc(n);
    // Update LRU cache of documents
    remove(hitDoc);               // remove from list, if there
    addToFront(hitDoc);           // add to front of list
    if (numDocs  > maxDocs) {      // if cache is full
      HitDoc oldLast = last;
      remove(last);             // flush last
      oldLast.doc = null;       // let doc get gc'd
    }
    if (hitDoc.doc == null) {
      hitDoc.doc = searcher.doc(hitDoc.id);  // cache miss: read document
    }
    return hitDoc.doc;
}

Deprecated!

^th

Documents are cached, so that repeated requests for the same element may return the same Document object.

 public final int id(int n) throws IOException {
    return hitDoc(n).id;
}

Deprecated!

^th

 public Iterator iterator() {
    return new HitIterator(this);
}

Deprecated!

HitIterator

Iterator#next()

Hit

 public final int length() {
    return length;
}

Deprecated!

Returns the total number of hits available in this set.

 public final float score(int n) throws IOException {
    return hitDoc(n).score;
}

Deprecated!

^th