Searchable
implements Closeable| org.apache.lucene.search.Searchable |
 Known Indirect Subclasses
|
Class Overview
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 matching hit. NOTE: this interface is kept public for convenience. Since it is not expected to be implemented directly, it may be changed unexpectedly between releases.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Frees resources associated with this Searcher.
| |||||||||||
Get the
Document at the nth position. | |||||||||||
Returns the stored fields of document
i. | |||||||||||
Expert: Returns the number of documents containing
term. | |||||||||||
Expert: For each term in the terms array, calculates the number of
documents containing
term. | |||||||||||
Expert: low-level implementation method
Returns an Explanation that describes how
doc scored against
weight. | |||||||||||
Expert: Returns one greater than the largest possible document number.
| |||||||||||
Expert: called to re-write queries into primitive queries.
| |||||||||||
Expert: Low-level search implementation.
| |||||||||||
Expert: Low-level search implementation with arbitrary sorting.
| |||||||||||
Lower-level search API.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
java.io.Closeable
| |||||||||||
Public Methods
public abstract void close ()
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.
Throws
| IOException |
|---|
public abstract Document doc (int n, FieldSelector fieldSelector)
Get the Document at the nth position. The FieldSelector
may be used to determine what Fields to load and how they should be loaded.
NOTE: If the underlying Reader (more specifically, the underlying FieldsReader) is closed before the lazy Field is
loaded an exception may be thrown. If you want the value of a lazy Field to be available after closing you must
explicitly load it or fetch the Document again with a new loader.
Parameters
| n | Get the document at the nth position |
|---|---|
| fieldSelector | The FieldSelector to use to determine what Fields should be loaded on the Document. May be null, in which case all Fields will be loaded. |
Returns
- The stored fields of the
Documentat the nth position
Throws
| CorruptIndexException | if the index is corrupt |
|---|---|
| IOException | if there is a low-level IO error |
public abstract Document doc (int i)
Returns the stored fields of document i.
Throws
| CorruptIndexException | if the index is corrupt |
|---|---|
| IOException | if there is a low-level IO error |
See Also
public abstract int docFreq (Term term)
public abstract int[] docFreqs (Term[] terms)
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.
Throws
| IOException |
|---|
public abstract Explanation explain (Weight weight, int doc)
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 explain(Query, int).
public abstract int maxDoc ()
public abstract Query rewrite (Query query)
Expert: called to re-write queries into primitive queries.
public abstract TopDocs search (Weight weight, Filter filter, int n)
Expert: Low-level search implementation. Finds the top n
hits for query, applying filter if non-null.
Applications should usually call search(Query, int) or
search(Query, Filter, int) instead.
public abstract TopFieldDocs search (Weight weight, Filter filter, int n, Sort sort)
Expert: Low-level search implementation with arbitrary sorting. Finds
the top n hits for query, applying
filter if non-null, and sorting the hits by the criteria in
sort.
Applications should usually call search(Query, Filter, int, Sort) instead.
public abstract void search (Weight weight, Filter filter, Collector collector)
Lower-level search API.
collect(int) is called for every document.
Collector-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 (search(Query, int)) is
usually more efficient, as it skips non-high-scoring hits.
Parameters
| weight | to match documents |
|---|---|
| filter | if non-null, used to permit documents to be collected. |
| collector | to receive hits |