org.apache.lucene.search

Class Hits


public final class Hits
extends Object

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

Method Summary

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

Method Details

doc

public final Document doc(int n)
            throws IOException
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)
            throws IOException
Returns the id for the nth document in this set.

iterator

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


length

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

score

public final float score(int n)
            throws IOException
Returns the score for the nth document in this set.

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