| org.apache.lucene.search.Searchable
All known Subclasses: org.apache.lucene.search.RemoteSearchable, org.apache.lucene.search.Searcher,
| Searchable | | public interface Searchable extends java.rmi.Remote(Code) | | 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. | | Document | doc(int n, FieldSelector fieldSelector)
Get the
org.apache.lucene.document.Document at the nth position. | | 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(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(Weight weight, Filter filter, HitCollector results)
Lower-level search API.
HitCollector.collect(intfloat) 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. | | 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. |
| close | | void close() throws IOException(Code) | | Frees resources associated with this Searcher.
Be careful not to call this method while you are still using objects
like
Hits .
|
| docFreqs | | int[] docFreqs(Term[] terms) throws IOException(Code) | | Expert: For each term in the terms array, calculates the number of
documents containing term. Returns an array with these
document frequencies. Used to minimize number of remote calls.
|
| explain | | Explanation explain(Weight weight, int doc) throws IOException(Code) | | Expert: low-level implementation method
Returns an Explanation that describes how 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(Queryint) .
throws:
BooleanQuery.TooManyClauses - |
| maxDoc | | int maxDoc() throws IOException(Code) | | Expert: Returns one greater than the largest possible document number.
Called by search code to compute term weights.
See Also: IndexReader.maxDoc |
| search | | void search(Weight weight, Filter filter, HitCollector results) throws IOException(Code) | | Lower-level search API.
HitCollector.collect(intfloat) 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.
Parameters:
weight - to match documents
Parameters:
filter - if non-null, a bitset used to eliminate some documents
Parameters:
results - to receive hits
throws:
BooleanQuery.TooManyClauses - |
|
|