org.apache.lucene.search

Class Hits

java.lang.Object

org.apache.lucene.search.Hits

public final class Hits
extends java.lang.Object

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).

Method Summary

Modifier and Type	Method and Description
Document	doc(int n) Returns the stored fields of the nth document in this set.
int	id(int n) Returns the id for the nth document in this set.
java.util.Iterator	iterator() Returns a HitIterator to navigate the Hits.
int	length() Returns the total number of hits available in this set.
float	score(int n) Returns the score for the nth document in this set.

Methods inherited from class java.lang.Object

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

Method Detail

length

public final int length()

Returns the total number of hits available in this set.

doc

public final Document doc(int n)
                   throws CorruptIndexException,
                          java.io.IOException

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.

Throws:

CorruptIndexException - if the index is corrupt

java.io.IOException - if there is a low-level IO error

score

public final float score(int n)
                  throws java.io.IOException

Returns the score for the n^th document in this set.

Throws:

java.io.IOException

id

public final int id(int n)
             throws java.io.IOException

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.

Throws:

java.io.IOException

iterator

public java.util.Iterator iterator()

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.