org.apache.lucene.search
Class RemoteSearchable

java.lang.Object
  extended by java.rmi.server.RemoteObject
      extended by java.rmi.server.RemoteServer
          extended by java.rmi.server.UnicastRemoteObject
              extended by org.apache.lucene.search.RemoteSearchable
All Implemented Interfaces:
Serializable, Remote, Searchable

public class RemoteSearchable
extends UnicastRemoteObject
implements Searchable

A remote searchable implementation.

Version:
$Id: RemoteSearchable.java 351472 2005-12-01 21:15:53Z bmesser $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Constructor Summary
RemoteSearchable(Searchable local)
          Constructs and exports a remote searcher.
 
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)
           
 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.
 void search(Query query, Filter filter, HitCollector results)
          Expert: Low-level search implementation.
 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.
 void search(Weight weight, Filter filter, HitCollector results)
          Lower-level search API.
 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.
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RemoteSearchable

public RemoteSearchable(Searchable local)
                 throws RemoteException
Constructs and exports a remote searcher.

Throws:
RemoteException
Method Detail

search

public void search(Query query,
                   Filter filter,
                   HitCollector results)
            throws IOException
Description copied from interface: Searchable
Expert: Low-level search implementation.

Specified by:
search in interface Searchable
Throws:
IOException

search

public void search(Weight weight,
                   Filter filter,
                   HitCollector results)
            throws IOException
Description copied from interface: Searchable
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.

Specified by:
search in interface Searchable
Parameters:
weight - to match documents
filter - if non-null, a bitset used to eliminate some documents
results - to receive hits
Throws:
IOException

close

public void close()
           throws IOException
Description copied from interface: Searchable
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects like Hits.

Specified by:
close in interface Searchable
Throws:
IOException

docFreq

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

Specified by:
docFreq in interface Searchable
Throws:
IOException
See Also:
IndexReader.docFreq(Term)

docFreqs

public int[] docFreqs(Term[] terms)
               throws IOException
Description copied from interface: Searchable
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.

Specified by:
docFreqs in interface Searchable
Throws:
IOException

maxDoc

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

Specified by:
maxDoc in interface Searchable
Throws:
IOException
See Also:
IndexReader.maxDoc()

search

public TopDocs search(Query query,
                      Filter filter,
                      int n)
               throws IOException
Description copied from interface: Searchable
Expert: Low-level search implementation.

Specified by:
search in interface Searchable
Throws:
IOException

search

public TopDocs search(Weight weight,
                      Filter filter,
                      int n)
               throws IOException
Description copied from interface: Searchable
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.

Specified by:
search in interface Searchable
Throws:
IOException

search

public TopFieldDocs search(Query query,
                           Filter filter,
                           int n,
                           Sort sort)
                    throws IOException
Description copied from interface: Searchable
Expert: Low-level search implementation.

Specified by:
search in interface Searchable
Throws:
IOException

search

public TopFieldDocs search(Weight weight,
                           Filter filter,
                           int n,
                           Sort sort)
                    throws IOException
Description copied from interface: Searchable
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.

Specified by:
search in interface Searchable
Throws:
IOException

doc

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

Specified by:
doc in interface Searchable
Throws:
IOException
See Also:
IndexReader.document(int)

rewrite

public Query rewrite(Query original)
              throws IOException
Description copied from interface: Searchable
Expert: called to re-write queries into primitive queries.

Specified by:
rewrite in interface Searchable
Throws:
IOException

explain

public Explanation explain(Query query,
                           int doc)
                    throws IOException
Specified by:
explain in interface Searchable
Throws:
IOException

explain

public Explanation explain(Weight weight,
                           int doc)
                    throws IOException
Description copied from interface: Searchable
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).

Specified by:
explain in interface Searchable
Throws:
IOException

main

public static void main(String[] args)
                 throws Exception
Exports a searcher for the index in args[0] named "//localhost/Searchable".

Throws:
Exception


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