org.apache.lucene.search

Interface Searchable

All Superinterfaces:
Remote
Known Implementing Classes:
IndexSearcher, MultiSearcher, ParallelMultiSearcher, RemoteSearchable, Searcher

public interface Searchable
extends 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.

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.
int[]
docFreqs(Term[] terms)
Expert: For each term in the terms array, calculates the number of documents containing term.
Explanation
explain(Query query, int doc)
Deprecated. use Searcher.explain(Weight,int) instead.
Explanation
explain(Weight weight, int doc)
Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
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.
TopDocs
search(Query query, Filter filter, int n)
Deprecated. use Searcher.search(Weight,Filter,int) instead.
TopFieldDocs
search(Query query, Filter filter, int n, Sort sort)
Deprecated. use Searcher.search(Weight,Filter,int,Sort) instead.
void
search(Query query, Filter filter, HitCollector results)
Deprecated. use Searcher.search(Weight,Filter,HitCollector) instead.
TopDocs
search(Weight weight, Filter filter, int n)
Expert: Low-level search implementation.
TopFieldDocs
search(Weight weight, Filter filter, int n, Sort sort)
Expert: Low-level search implementation with arbitrary sorting.
void
search(Weight weight, Filter filter, HitCollector results)
Lower-level search API.

Method Details

close

public void close()
            throws IOException

doc

public Document doc(int i)
            throws IOException
Expert: Returns the stored fields of document i. Called by HitCollector implementations.

docFreq

public int docFreq(Term term)
            throws IOException
Expert: Returns the number of documents containing term. Called by search code to compute term weights.

docFreqs

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.

explain

public Explanation explain(Query query,
                           int doc)
            throws IOException

Deprecated. use Searcher.explain(Weight,int) instead.


explain

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).


maxDoc

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

rewrite

public Query rewrite(Query query)
            throws IOException
Expert: called to re-write queries into primitive queries.

search

public TopDocs search(Query query,
                      Filter filter,
                      int n)
            throws IOException

Deprecated. use Searcher.search(Weight,Filter,int) instead.

Expert: Low-level search implementation.

search

public TopFieldDocs search(Query query,
                           Filter filter,
                           int n,
                           Sort sort)
            throws IOException

Deprecated. use Searcher.search(Weight,Filter,int,Sort) instead.

Expert: Low-level search implementation.

search

public void search(Query query,
                   Filter filter,
                   HitCollector results)
            throws IOException

Deprecated. use Searcher.search(Weight,Filter,HitCollector) instead.

Expert: Low-level search implementation.

search

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.


search

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.


search

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.

Parameters:
weight - to match documents
filter - if non-null, a bitset used to eliminate some documents
results - to receive hits

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.