org.apache.lucene.search
public interface Searchable extends Remote
Implementations provide search over a single index, over multiple indices, and over indices on remote servers.
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 .
|
Explanation | explain(Query query, int doc) Returns an Explanation that describes how doc scored against
query .
|
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) Lower-level search API.
|
TopDocs | search(Query query, Filter filter, int n) Expert: Low-level search implementation. |
TopFieldDocs | search(Query query, Filter filter, int n, Sort sort) Expert: Low-level search implementation with arbitrary sorting. |
i
.
Called by {@link HitCollector} implementations.See Also: .
term
.
Called by search code to compute term weights.See Also: .
doc
scored against
query
.
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.
See Also: .
{@link HitCollector#collect(int,float)} is called for every non-zero scoring document.
Applications should only use this if they need all of the matching documents. The high-level search API ({@link Searcher#search(Query)}) is usually more efficient, as it skips non-high-scoring hits.
Parameters: query to match documents filter if non-null, a bitset used to eliminate some documents results to receive hits
n
hits for query
, applying filter
if non-null.
Called by {@link Hits}.
Applications should usually call {@link Searcher#search(Query)} or {@link Searcher#search(Query,Filter)} instead.
n
hits for query
, applying
filter
if non-null, and sorting the hits by the criteria in
sort
.
Applications should usually call {@link Searcher#search(Query,Filter,Sort)} instead.