Home » lucene-2.4.1-src » org.apache » lucene » search » [javadoc | source]

org.apache.lucene.search
public interface: Searchable [javadoc | source]

All Implemented Interfaces:
    Remote

All Known Implementing Classes:
    CachedDfSource, RemoteSearchable, MultiSearcher, IndexSearcher, ParallelMultiSearcher, Searcher

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.

Method from org.apache.lucene.search.Searchable Summary:
close,   doc,   doc,   docFreq,   docFreqs,   explain,   maxDoc,   rewrite,   search,   search,   search

Method from org.apache.lucene.search.Searchable Detail:
public void close() throws IOException Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects like Hits .
public Document doc(int i) throws IOException, CorruptIndexException Expert: Returns the stored fields of document i. Called by HitCollector implementations.
public Document doc(int n, FieldSelector fieldSelector) throws IOException, CorruptIndexException Get the org.apache.lucene.document.Document at the nth position. The org.apache.lucene.document.FieldSelector may be used to determine what org.apache.lucene.document.Field s to load and how they should be loaded. NOTE: If the underlying Reader (more specifically, the underlying FieldsReader) is closed before the lazy org.apache.lucene.document.Field is loaded an exception may be thrown. If you want the value of a lazy org.apache.lucene.document.Field to be available after closing you must explicitly load it or fetch the Document again with a new loader.
public int docFreq(Term term) throws IOException Expert: Returns the number of documents containing term. Called by search code to compute term weights.
public int[] docFreqs(Term[] terms) throws IOException 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.
public Explanation explain(Weight weight, int doc) throws IOException 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 Searcher#explain(Query, int) .
public int maxDoc() throws IOException Expert: Returns one greater than the largest possible document number. Called by search code to compute term weights.
public Query rewrite(Query query) throws IOException Expert: called to re-write queries into primitive queries.
public void search(Weight weight, Filter filter, HitCollector results) throws IOException Lower-level search API. HitCollector#collect(int,float) is called for every non-zero scoring document. HitCollector-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) ) is usually more efficient, as it skips non-high-scoring hits.
public TopDocs search(Weight weight, Filter filter, int n) throws IOException Expert: Low-level search implementation. Finds the top n hits for query, applying filter if non-null. Called by Hits . Applications should usually call Searcher#search(Query) or Searcher#search(Query,Filter) instead.
public TopFieldDocs search(Weight weight, Filter filter, int n, Sort sort) throws IOException 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 Searcher#search(Query,Filter,Sort) instead.