org.apache.lucene.search
public final class Hits extends Object
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).
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.
|
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.
|
public final int length()
public final Document doc(int n) throws CorruptIndexException, IOException
Documents are cached, so that repeated requests for the same element may return the same Document object.
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorpublic final float score(int n) throws IOException
IOException
public final int id(int n) throws IOException
IOException
public Iterator iterator()
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
.
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.