org.apache.lucene.search

Class Hits

public final class Hits extends Object

A ranked list of documents, used to hold search results.
Method Summary
Documentdoc(int n)
Returns the stored fields of the nth document in this set.
intid(int n)
Returns the id for the nth document in this set.
Iteratoriterator()
Returns a {@link HitIterator} to navigate the Hits.
intlength()
Returns the total number of hits available in this set.
floatscore(int n)
Returns the score for the nth document in this set.

Method Detail

doc

public final Document doc(int n)
Returns the stored fields of the nth document in this set.

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

id

public final int id(int n)
Returns the id for the nth document in this set.

iterator

public Iterator iterator()
Returns a {@link HitIterator} to navigate the Hits. Each item returned from {@link Iterator#next()} is a {@link Hit}.

Caution: Iterate only over the hits needed. Iterating over all hits is generally not desirable and may be the source of performance issues.

length

public final int length()
Returns the total number of hits available in this set.

score

public final float score(int n)
Returns the score for the nth document in this set.
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.