|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface for search implementations.
Implementations provide search over a single index, over multiple indices, and over indices on remote servers.
Method Summary | |
void |
close()
Frees resources associated with this Searcher. |
Document |
doc(int i)
Expert: Returns the stored fields of document i . |
int |
docFreq(Term term)
Expert: Returns the number of documents containing term . |
Explanation |
explain(Query query,
int doc)
Returns an Explanation that describes how doc scored against
query . |
int |
maxDoc()
Expert: Returns one greater than the largest possible document number. |
Query |
rewrite(Query query)
Expert: called to re-write queries into primitive queries. |
void |
search(Query query,
Filter filter,
HitCollector results)
Lower-level search API. |
TopDocs |
search(Query query,
Filter filter,
int n)
Expert: Low-level search implementation. |
Method Detail |
public void search(Query query, Filter filter, HitCollector results) throws IOException
HitCollector.collect(int,float)
is called for every non-zero
scoring document.
Applications should only use this if they need all of the
matching documents. The high-level search API (Searcher.search(Query)
) is usually more efficient, as it skips
non-high-scoring hits.
query
- to match documentsfilter
- if non-null, a bitset used to eliminate some documentsresults
- to receive hits
IOException
public void close() throws IOException
IOException
public int docFreq(Term term) throws IOException
term
.
Called by search code to compute term weights.
IOException
IndexReader.docFreq(Term).
public int maxDoc() throws IOException
IOException
IndexReader.maxDoc().
public TopDocs search(Query query, Filter filter, int n) throws IOException
n
hits for query
, applying filter
if non-null.
Called by Hits
.
Applications should usually call Searcher.search(Query)
or
Searcher.search(Query,Filter)
instead.
IOException
public Document doc(int i) throws IOException
i
.
Called by HitCollector
implementations.
IOException
IndexReader.document(int).
public Query rewrite(Query query) throws IOException
IOException
public Explanation explain(Query query, int doc) throws IOException
doc
scored against
query
.
This is intended to be used in developing Similarity implementations, and, for good performance, should not be displayed with every hit. Computing an explanation is as expensive as executing the query over the entire index.
IOException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |