FileDocCategorySizeDatePackage
Searchable.javaAPI DocApache Lucene 2.2.06838Sat Jun 16 22:20:34 BST 2007org.apache.lucene.search

Searchable

public interface Searchable implements Remote
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 non-zero scoring hit.

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)
throws
CorruptIndexException if the index is corrupt
throws
IOException if there is a low-level IO error

public org.apache.lucene.document.Documentdoc(int n, org.apache.lucene.document.FieldSelector fieldSelector)
Get the {@link org.apache.lucene.document.Document} at the nth position. The {@link org.apache.lucene.document.FieldSelector} may be used to determine what {@link 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 {@link org.apache.lucene.document.Field} is loaded an exception may be thrown. If you want the value of a lazy {@link org.apache.lucene.document.Field} to be available after closing you must explicitly load it or fetch the Document again with a new loader.

param
n Get the document at the nth position
param
fieldSelector The {@link org.apache.lucene.document.FieldSelector} to use to determine what Fields should be loaded on the Document. May be null, in which case all Fields will be loaded.
return
The stored fields of the {@link org.apache.lucene.document.Document} at the nth position
throws
CorruptIndexException if the index is corrupt
throws
IOException if there is a low-level IO error
see
IndexReader#document(int, FieldSelector)
see
org.apache.lucene.document.Fieldable
see
org.apache.lucene.document.FieldSelector
see
org.apache.lucene.document.SetBasedFieldSelector
see
org.apache.lucene.document.LoadFirstFieldSelector

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 int[]docFreqs(org.apache.lucene.index.Term[] terms)
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 org.apache.lucene.search.Explanationexplain(org.apache.lucene.search.Weight weight, int doc)
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 {@link Searcher#explain(Query, int)}.

throws
BooleanQuery.TooManyClauses

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.

throws
BooleanQuery.TooManyClauses

public voidsearch(org.apache.lucene.search.Weight weight, 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.
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 ({@link Searcher#search(Query)}) is usually more efficient, as it skips non-high-scoring hits.

param
weight to match documents
param
filter if non-null, a bitset used to eliminate some documents
param
results to receive hits
throws
BooleanQuery.TooManyClauses

public org.apache.lucene.search.TopFieldDocssearch(org.apache.lucene.search.Weight weight, 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.

throws
BooleanQuery.TooManyClauses

public org.apache.lucene.search.TopDocssearch(org.apache.lucene.search.Weight weight, 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.

throws
BooleanQuery.TooManyClauses