@Deprecated public interface Searchable extends Closeable
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.
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Deprecated.
Frees resources associated with this Searcher.
|
Document |
doc(int i)
Deprecated.
Returns the stored fields of document
i. |
Document |
doc(int n,
FieldSelector fieldSelector)
Deprecated.
Get the
Document at the nth position. |
int |
docFreq(Term term)
Deprecated.
Expert: Returns the number of documents containing
term. |
int[] |
docFreqs(Term[] terms)
Deprecated.
Expert: For each term in the terms array, calculates the number of
documents containing
term. |
Explanation |
explain(Weight weight,
int doc)
Deprecated.
Expert: low-level implementation method
Returns an Explanation that describes how
doc scored against
weight. |
int |
maxDoc()
Deprecated.
Expert: Returns one greater than the largest possible document number.
|
Query |
rewrite(Query query)
Deprecated.
Expert: called to re-write queries into primitive queries.
|
void |
search(Weight weight,
Filter filter,
Collector collector)
Deprecated.
Lower-level search API.
|
TopDocs |
search(Weight weight,
Filter filter,
int n)
Deprecated.
Expert: Low-level search implementation.
|
TopFieldDocs |
search(Weight weight,
Filter filter,
int n,
Sort sort)
Deprecated.
Expert: Low-level search implementation with arbitrary sorting.
|
void search(Weight weight, Filter filter, Collector collector) throws IOException
Collector.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 (Searcher.search(Query,int)) is
usually more efficient, as it skips non-high-scoring hits.
weight - to match documentsfilter - if non-null, used to permit documents to be collected.collector - to receive hitsBooleanQuery.TooManyClausesIOExceptionvoid close()
throws IOException
close in interface CloseableIOExceptionint docFreq(Term term) throws IOException
term.IOExceptionIndexReader.docFreq(Term)int[] docFreqs(Term[] terms) throws IOException
term. Returns an array with these
document frequencies. Used to minimize number of remote calls.IOExceptionint maxDoc()
throws IOException
IOExceptionIndexReader.maxDoc()TopDocs search(Weight weight, Filter filter, int n) throws IOException
n
hits for query, applying filter if non-null.
Applications should usually call Searcher.search(Query,int) or
Searcher.search(Query,Filter,int) instead.
Document doc(int i) throws CorruptIndexException, IOException
i.CorruptIndexException - if the index is corruptIOException - if there is a low-level IO errorIndexReader.document(int)Document doc(int n, FieldSelector fieldSelector) throws CorruptIndexException, IOException
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.n - Get the document at the nth positionfieldSelector - 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.Document at the nth positionCorruptIndexException - if the index is corruptIOException - if there is a low-level IO errorIndexReader.document(int, FieldSelector),
Fieldable,
FieldSelector,
SetBasedFieldSelector,
LoadFirstFieldSelectorQuery rewrite(Query query) throws 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).
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,int,Sort) instead.