FileDocCategorySizeDatePackage
Searchable.javaAPI DocApache Lucene 1.4.33886Tue Mar 30 00:48:04 BST 2004org.apache.lucene.search

Searchable

public interface Searchable implements Remote
The interface for search implementations.

Implementations provide search over a single index, over multiple indices, and over indices on remote servers.

Fields Summary
Constructors Summary
Methods Summary
public voidclose()
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects like {@link Hits}.

public org.apache.lucene.document.Documentdoc(int i)
Expert: Returns the stored fields of document i. Called by {@link HitCollector} implementations.

see
IndexReader#document(int).

public intdocFreq(org.apache.lucene.index.Term term)
Expert: Returns the number of documents containing term. Called by search code to compute term weights.

see
IndexReader#docFreq(Term).

public org.apache.lucene.search.Explanationexplain(org.apache.lucene.search.Query query, int doc)
Returns an Explanation that describes how 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.

public intmaxDoc()
Expert: Returns one greater than the largest possible document number. Called by search code to compute term weights.

see
IndexReader#maxDoc().

public org.apache.lucene.search.Queryrewrite(org.apache.lucene.search.Query query)
Expert: called to re-write queries into primitive queries.

public voidsearch(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.HitCollector results)
Lower-level search API.

{@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.

param
query to match documents
param
filter if non-null, a bitset used to eliminate some documents
param
results to receive hits

public org.apache.lucene.search.TopDocssearch(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, int n)
Expert: Low-level search implementation. Finds the top 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.

public org.apache.lucene.search.TopFieldDocssearch(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, int n, org.apache.lucene.search.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 {@link Searcher#search(Query,Filter,Sort)} instead.