Class RemoteSearchable
- java.lang.Object
-
- java.rmi.server.RemoteObject
-
- java.rmi.server.RemoteServer
-
- java.rmi.server.UnicastRemoteObject
-
- org.apache.lucene.search.RemoteSearchable
-
- All Implemented Interfaces:
Closeable
,Serializable
,AutoCloseable
,Remote
,RMIRemoteSearchable
,Searchable
@Deprecated public class RemoteSearchable extends UnicastRemoteObject implements RMIRemoteSearchable
Deprecated.This package (all of contrib/remote) will be removed in 4.0.A remote searchable implementation.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.rmi.server.RemoteObject
ref
-
-
Constructor Summary
Constructors Constructor Description RemoteSearchable(Searchable local)
Deprecated.Constructs and exports a remote searcher.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
close()
Deprecated.Frees resources associated with this Searcher.Document
doc(int i)
Deprecated.Returns the stored fields of documenti
.Document
doc(int i, FieldSelector fieldSelector)
Deprecated.Get theDocument
at then
th position.int
docFreq(Term term)
Deprecated.Expert: Returns the number of documents containingterm
.int[]
docFreqs(Term[] terms)
Deprecated.Expert: For each term in the terms array, calculates the number of documents containingterm
.Explanation
explain(Weight weight, int doc)
Deprecated.Expert: low-level implementation method Returns an Explanation that describes howdoc
scored againstweight
.static void
main(String[] args)
Deprecated.Exports a searcher for the index in args[0] named "//localhost/Searchable".int
maxDoc()
Deprecated.Expert: Returns one greater than the largest possible document number.Query
rewrite(Query original)
Deprecated.Expert: called to re-write queries into primitive queries.TopDocs
search(Weight weight, Filter filter, int n)
Deprecated.Expert: Low-level search implementation.TopFieldDocs
search(Weight weight, Filter filter, int n, Sort sort)
Deprecated.Expert: Low-level search implementation with arbitrary sorting.void
search(Weight weight, Filter filter, Collector results)
Deprecated.Lower-level search API.-
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObject
-
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
-
-
-
-
Constructor Detail
-
RemoteSearchable
public RemoteSearchable(Searchable local) throws RemoteException
Deprecated.Constructs and exports a remote searcher.- Throws:
RemoteException
-
-
Method Detail
-
search
public void search(Weight weight, Filter filter, Collector results) throws IOException
Deprecated.Description copied from interface:Searchable
Lower-level search API.Collector.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 (
Searcher.search(Query,int)
) is usually more efficient, as it skips non-high-scoring hits.- Specified by:
search
in interfaceSearchable
- Parameters:
weight
- to match documentsfilter
- if non-null, used to permit documents to be collected.results
- to receive hits- Throws:
IOException
-
close
public void close() throws IOException
Deprecated.Description copied from interface:Searchable
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceSearchable
- Throws:
IOException
-
docFreq
public int docFreq(Term term) throws IOException
Deprecated.Description copied from interface:Searchable
Expert: Returns the number of documents containingterm
.- Specified by:
docFreq
in interfaceSearchable
- Throws:
IOException
- See Also:
IndexReader.docFreq(Term)
-
docFreqs
public int[] docFreqs(Term[] terms) throws IOException
Deprecated.Description copied from interface:Searchable
Expert: For each term in the terms array, calculates the number of documents containingterm
. Returns an array with these document frequencies. Used to minimize number of remote calls.- Specified by:
docFreqs
in interfaceSearchable
- Throws:
IOException
-
maxDoc
public int maxDoc() throws IOException
Deprecated.Description copied from interface:Searchable
Expert: Returns one greater than the largest possible document number.- Specified by:
maxDoc
in interfaceSearchable
- Throws:
IOException
- See Also:
IndexReader.maxDoc()
-
search
public TopDocs search(Weight weight, Filter filter, int n) throws IOException
Deprecated.Description copied from interface:Searchable
Expert: Low-level search implementation. Finds the topn
hits forquery
, applyingfilter
if non-null.Applications should usually call
Searcher.search(Query,int)
orSearcher.search(Query,Filter,int)
instead.- Specified by:
search
in interfaceSearchable
- Throws:
IOException
-
search
public TopFieldDocs search(Weight weight, Filter filter, int n, Sort sort) throws IOException
Deprecated.Description copied from interface:Searchable
Expert: Low-level search implementation with arbitrary sorting. Finds the topn
hits forquery
, applyingfilter
if non-null, and sorting the hits by the criteria insort
.Applications should usually call
Searcher.search(Query,Filter,int,Sort)
instead.- Specified by:
search
in interfaceSearchable
- Throws:
IOException
-
doc
public Document doc(int i) throws CorruptIndexException, IOException
Deprecated.Description copied from interface:Searchable
Returns the stored fields of documenti
.- Specified by:
doc
in interfaceSearchable
- Throws:
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO error- See Also:
IndexReader.document(int)
-
doc
public Document doc(int i, FieldSelector fieldSelector) throws CorruptIndexException, IOException
Deprecated.Description copied from interface:Searchable
Get theDocument
at then
th position. TheFieldSelector
may be used to determine whatField
s to load and how they should be loaded. NOTE: If the underlying Reader (more specifically, the underlyingFieldsReader
) is closed before the lazyField
is loaded an exception may be thrown. If you want the value of a lazyField
to be available after closing you must explicitly load it or fetch the Document again with a new loader.- Specified by:
doc
in interfaceSearchable
- Parameters:
i
- Get the document at then
th positionfieldSelector
- TheFieldSelector
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 - Throws:
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO error- See Also:
IndexReader.document(int, FieldSelector)
,Fieldable
,FieldSelector
,SetBasedFieldSelector
,LoadFirstFieldSelector
-
rewrite
public Query rewrite(Query original) throws IOException
Deprecated.Description copied from interface:Searchable
Expert: called to re-write queries into primitive queries.- Specified by:
rewrite
in interfaceSearchable
- Throws:
IOException
-
explain
public Explanation explain(Weight weight, int doc) throws IOException
Deprecated.Description copied from interface:Searchable
Expert: low-level implementation method Returns an Explanation that describes howdoc
scored againstweight
.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 interfaceSearchable
- Throws:
IOException
-
-