org.apache.lucene.search
Class RemoteSearchable
UnicastRemoteObject
org.apache.lucene.search.RemoteSearchable
- java.rmi.Remote, Searchable
public class RemoteSearchable
extends UnicastRemoteObject
A remote searchable implementation.
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 .
|
static void | main(args[] ) - Exports a searcher for the index in args[0] named
"//localhost/Searchable".
|
int | maxDoc() - Expert: Returns one greater than the largest possible document number.
|
Query | rewrite(Query original) - Expert: called to re-write queries into primitive queries.
|
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.
|
void | search(Query query, Filter filter, HitCollector results) - Lower-level search API.
|
RemoteSearchable
public RemoteSearchable(Searchable local)
throws RemoteException
Constructs and exports a remote searcher.
close
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
.
- close in interface Searchable
doc
public Document doc(int i)
throws IOException
Expert: Returns the stored fields of document
i
.
Called by
HitCollector
implementations.
- doc in interface Searchable
IndexReader.document(int).
docFreq
public int docFreq(Term term)
throws IOException
Expert: Returns the number of documents containing term
.
Called by search code to compute term weights.
- docFreq in interface Searchable
IndexReader.docFreq(Term).
explain
public Explanation explain(Query query,
int doc)
throws IOException
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.
- explain in interface Searchable
main
public static void main(args[] )
throws Exception
Exports a searcher for the index in args[0] named
"//localhost/Searchable".
maxDoc
public int maxDoc()
throws IOException
Expert: Returns one greater than the largest possible document number.
Called by search code to compute term weights.
- maxDoc in interface Searchable
rewrite
public Query rewrite(Query original)
throws IOException
Expert: called to re-write queries into primitive queries.
- rewrite in interface Searchable
search
public void search(Query query,
Filter filter,
HitCollector results)
throws IOException
Lower-level search API.
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 (
Searcher.search(Query)
) is usually more efficient, as it skips
non-high-scoring hits.
- search in interface Searchable
query
- to match documentsfilter
- if non-null, a bitset used to eliminate some documentsresults
- to receive hits
Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.