Interface Searchable
-
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Subinterfaces:
RMIRemoteSearchable
- All Known Implementing Classes:
AssertingIndexSearcher
,CheckHits.ExplanationAssertingSearcher
,IndexSearcher
,MultiSearcher
,ParallelMultiSearcher
,RemoteSearchable
,Searcher
@Deprecated public interface Searchable extends Closeable
Deprecated.In 4.0 this interface is removed/absorbed into IndexSearcherThe 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
close()
Deprecated.Frees resources associated with this Searcher.Document
doc(int i)
Deprecated.Returns the stored fields of documenti
.Document
doc(int n, FieldSelector fieldSelector)
Deprecated.Get theDocument
at then
th position.int
docFreq(Term term)
Deprecated.Expert: Returns the number of documents containingterm
.int[]
docFreqs(Term[] terms)
Deprecated.Expert: For each term in the terms array, calculates the number of documents containingterm
.Explanation
explain(Weight weight, int doc)
Deprecated.Expert: low-level implementation method Returns an Explanation that describes howdoc
scored againstweight
.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.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)
Deprecated.Lower-level search API.
-
-
-
Method Detail
-
search
void search(Weight weight, Filter filter, Collector collector) throws IOException
Deprecated.Lower-level search API.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.- Parameters:
weight
- to match documentsfilter
- if non-null, used to permit documents to be collected.collector
- to receive hits- Throws:
BooleanQuery.TooManyClauses
IOException
-
close
void close() throws IOException
Deprecated.Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
docFreq
int docFreq(Term term) throws IOException
Deprecated.Expert: Returns the number of documents containingterm
.- Throws:
IOException
- See Also:
IndexReader.docFreq(Term)
-
docFreqs
int[] docFreqs(Term[] terms) throws IOException
Deprecated.Expert: For each term in the terms array, calculates the number of documents containingterm
. Returns an array with these document frequencies. Used to minimize number of remote calls.- Throws:
IOException
-
maxDoc
int maxDoc() throws IOException
Deprecated.Expert: Returns one greater than the largest possible document number.- Throws:
IOException
- See Also:
IndexReader.maxDoc()
-
search
TopDocs search(Weight weight, Filter filter, int n) throws IOException
Deprecated.Expert: Low-level search implementation. Finds the topn
hits forquery
, applyingfilter
if non-null.Applications should usually call
Searcher.search(Query,int)
orSearcher.search(Query,Filter,int)
instead.
-
doc
Document doc(int i) throws CorruptIndexException, IOException
Deprecated.Returns the stored fields of documenti
.- Throws:
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO error- See Also:
IndexReader.document(int)
-
doc
Document doc(int n, FieldSelector fieldSelector) throws CorruptIndexException, IOException
Deprecated.Get theDocument
at then
th position. TheFieldSelector
may be used to determine whatField
s to load and how they should be loaded. NOTE: If the underlying Reader (more specifically, the underlyingFieldsReader
) is closed before the lazyField
is loaded an exception may be thrown. If you want the value of a lazyField
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 then
th positionfieldSelector
- TheFieldSelector
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
Document
at the nth position - Throws:
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO error- See Also:
IndexReader.document(int, FieldSelector)
,Fieldable
,FieldSelector
,SetBasedFieldSelector
,LoadFirstFieldSelector
-
rewrite
Query rewrite(Query query) throws IOException
Deprecated.Expert: called to re-write queries into primitive queries.
-
explain
Explanation explain(Weight weight, int doc) throws IOException
Deprecated.Expert: low-level implementation method Returns an Explanation that describes howdoc
scored againstweight
.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)
.
-
search
TopFieldDocs search(Weight weight, Filter filter, int n, Sort sort) throws IOException
Deprecated.Expert: Low-level search implementation with arbitrary sorting. Finds the topn
hits forquery
, applyingfilter
if non-null, and sorting the hits by the criteria insort
.Applications should usually call
Searcher.search(Query,Filter,int,Sort)
instead.
-
-