|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Searchable
The interface for search implementations.
Searchable is the abstract network protocol for searching. Implementations provide search over a single index, over multiple indices, and over indices on remote servers.
Queries, filters and sort criteria are designed to be compact so that they may be efficiently passed to a remote index, with only the top-scoring hits being returned, rather than every non-zero scoring hit.
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 . |
int[] |
docFreqs(Term[] terms)
Expert: For each term in the terms array, calculates the number of documents containing term . |
Explanation |
explain(Query query,
int doc)
Deprecated. use Searcher.explain(Weight, int) instead. |
Explanation |
explain(Weight weight,
int doc)
Expert: low-level implementation method Returns an Explanation that describes how doc scored against
weight . |
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)
Deprecated. use Searcher.search(Weight, Filter, HitCollector) instead. |
TopDocs |
search(Query query,
Filter filter,
int n)
Deprecated. use Searcher.search(Weight, Filter, int) instead. |
TopFieldDocs |
search(Query query,
Filter filter,
int n,
Sort sort)
Deprecated. use Searcher.search(Weight, Filter, int, Sort) instead. |
void |
search(Weight weight,
Filter filter,
HitCollector results)
Lower-level search API. |
TopDocs |
search(Weight weight,
Filter filter,
int n)
Expert: Low-level search implementation. |
TopFieldDocs |
search(Weight weight,
Filter filter,
int n,
Sort sort)
Expert: Low-level search implementation with arbitrary sorting. |
Method Detail |
---|
void search(Weight weight, Filter filter, HitCollector results) throws IOException
HitCollector.collect(int,float)
is called for every non-zero
scoring document.
HitCollector-based access to remote indexes is discouraged.
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.
weight
- to match documentsfilter
- if non-null, a bitset used to eliminate some documentsresults
- to receive hits
BooleanQuery.TooManyClauses
IOException
void search(Query query, Filter filter, HitCollector results) throws IOException
Searcher.search(Weight, Filter, HitCollector)
instead.
IOException
void close() throws IOException
Hits
.
IOException
int docFreq(Term term) throws IOException
term
.
Called by search code to compute term weights.
IOException
IndexReader.docFreq(Term)
int[] docFreqs(Term[] terms) throws IOException
term
. Returns an array with these
document frequencies. Used to minimize number of remote calls.
IOException
int maxDoc() throws IOException
IOException
IndexReader.maxDoc()
TopDocs search(Weight weight, 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.
BooleanQuery.TooManyClauses
IOException
TopDocs search(Query query, Filter filter, int n) throws IOException
Searcher.search(Weight, Filter, int)
instead.
IOException
Document doc(int i) throws IOException
i
.
Called by HitCollector
implementations.
IOException
IndexReader.document(int)
Query rewrite(Query query) throws IOException
BooleanQuery.TooManyClauses
IOException
Explanation explain(Weight weight, int doc) throws IOException
doc
scored against
weight
.
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.
Applications should call Searcher.explain(Query, int)
.
BooleanQuery.TooManyClauses
IOException
Explanation explain(Query query, int doc) throws IOException
Searcher.explain(Weight, int)
instead.
IOException
TopFieldDocs search(Weight weight, Filter filter, int n, Sort sort) throws IOException
n
hits for query
, applying
filter
if non-null, and sorting the hits by the criteria in
sort
.
Applications should usually call Searcher.search(Query,Filter,Sort)
instead.
BooleanQuery.TooManyClauses
IOException
TopFieldDocs search(Query query, Filter filter, int n, Sort sort) throws IOException
Searcher.search(Weight, Filter, int, Sort)
instead.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |