@Deprecated public class

RemoteSearchable

extends UnicastRemoteObject
implements RMIRemoteSearchable
java.lang.Object
   ↳ java.rmi.server.RemoteObject
     ↳ java.rmi.server.RemoteServer
       ↳ java.rmi.server.UnicastRemoteObject
         ↳ org.apache.lucene.search.RemoteSearchable

This class is deprecated.
This package (all of contrib/remote) will be removed in 4.0.

Class Overview

A remote searchable implementation.

Summary

[Expand]
Inherited Fields
From class java.rmi.server.RemoteObject
Public Constructors
RemoteSearchable(Searchable local)
Constructs and exports a remote searcher.
Public Methods
void close()
Frees resources associated with this Searcher.
Document doc(int i, FieldSelector fieldSelector)
Get the Document at the nth position.
Document doc(int i)
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(Weight weight, int doc)
Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
static void main(String[] 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(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, Collector results)
Lower-level search API.
[Expand]
Inherited Methods
From class java.rmi.server.UnicastRemoteObject
From class java.rmi.server.RemoteServer
From class java.rmi.server.RemoteObject
From class java.lang.Object
From interface java.io.Closeable
From interface org.apache.lucene.search.Searchable

Public Constructors

public RemoteSearchable (Searchable local)

Constructs and exports a remote searcher.

Public Methods

public void close ()

Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.

Throws
IOException

public Document doc (int i, FieldSelector fieldSelector)

Get the Document at the nth position. The FieldSelector may be used to determine what Fields to load and how they should be loaded. NOTE: If the underlying Reader (more specifically, the underlying FieldsReader) is closed before the lazy Field is loaded an exception may be thrown. If you want the value of a lazy Field to be available after closing you must explicitly load it or fetch the Document again with a new loader.

Parameters
i Get the document at the nth position
fieldSelector The FieldSelector to use to determine what Fields should be loaded on the Document. May be null, in which case all Fields will be loaded.
Returns
  • The stored fields of the Document at the nth position

public Document doc (int i)

Returns the stored fields of document i.

public int docFreq (Term term)

Expert: Returns the number of documents containing term.

Throws
IOException

public int[] docFreqs (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.

Throws
IOException

public Explanation explain (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 explain(Query, int).

Throws
IOException

public static void main (String[] args)

Exports a searcher for the index in args[0] named "//localhost/Searchable".

Throws
Exception

public int maxDoc ()

Expert: Returns one greater than the largest possible document number.

Throws
IOException

public Query rewrite (Query original)

Expert: called to re-write queries into primitive queries.

Throws
IOException

public TopDocs search (Weight weight, Filter filter, int n)

Expert: Low-level search implementation. Finds the top n hits for query, applying filter if non-null.

Applications should usually call search(Query, int) or search(Query, Filter, int) instead.

Throws
IOException

public TopFieldDocs search (Weight weight, Filter filter, int n, 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 search(Query, Filter, int, Sort) instead.

Throws
IOException

public void search (Weight weight, Filter filter, Collector results)

Lower-level search API.

collect(int) is called for every document.
Collector-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 (search(Query, int)) is usually more efficient, as it skips non-high-scoring hits.

Parameters
weight to match documents
filter if non-null, used to permit documents to be collected.
results to receive hits
Throws
IOException