|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.search.Searcher
org.apache.lucene.search.IndexSearcher
public class IndexSearcher
Implements search over a single IndexReader.
Applications usually need only call the inherited Searcher.search(Query)
or Searcher.search(Query,Filter)
methods. For performance reasons it is
recommended to open only one IndexSearcher and use it for all of your searches.
Note that you can only access Hits from an IndexSearcher as long as it is not yet closed, otherwise an IOException will be thrown.
Constructor Summary | |
---|---|
IndexSearcher(Directory directory)
Creates a searcher searching the index in the provided directory. |
|
IndexSearcher(IndexReader r)
Creates a searcher searching the provided index. |
|
IndexSearcher(java.lang.String path)
Creates a searcher searching the index in the named directory. |
Method Summary | |
---|---|
void |
close()
Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(IndexReader r). |
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(Weight weight,
int doc)
Expert: low-level implementation method Returns an Explanation that describes how doc scored against
weight . |
IndexReader |
getIndexReader()
Return the IndexReader this searches. |
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(Weight weight,
Filter filter,
HitCollector results)
Lower-level search API. |
TopDocs |
search(Weight weight,
Filter filter,
int nDocs)
Expert: Low-level search implementation. |
TopFieldDocs |
search(Weight weight,
Filter filter,
int nDocs,
Sort sort)
Expert: Low-level search implementation with arbitrary sorting. |
Methods inherited from class org.apache.lucene.search.Searcher |
---|
createWeight, docFreqs, explain, getSimilarity, search, search, search, search, search, search, search, search, setSimilarity |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IndexSearcher(java.lang.String path) throws java.io.IOException
java.io.IOException
public IndexSearcher(Directory directory) throws java.io.IOException
java.io.IOException
public IndexSearcher(IndexReader r)
Method Detail |
---|
public IndexReader getIndexReader()
IndexReader
this searches.
public void close() throws java.io.IOException
close
in interface Searchable
close
in class Searcher
java.io.IOException
public int docFreq(Term term) throws java.io.IOException
Searchable
term
.
Called by search code to compute term weights.
docFreq
in interface Searchable
docFreq
in class Searcher
java.io.IOException
IndexReader.docFreq(Term)
public Document doc(int i) throws java.io.IOException
Searchable
i
.
Called by HitCollector
implementations.
doc
in interface Searchable
doc
in class Searcher
java.io.IOException
IndexReader.document(int)
public int maxDoc() throws java.io.IOException
Searchable
maxDoc
in interface Searchable
maxDoc
in class Searcher
java.io.IOException
IndexReader.maxDoc()
public TopDocs search(Weight weight, Filter filter, int nDocs) throws java.io.IOException
Searchable
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
in interface Searchable
search
in class Searcher
java.io.IOException
public TopFieldDocs search(Weight weight, Filter filter, int nDocs, Sort sort) throws java.io.IOException
Searchable
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
in interface Searchable
search
in class Searcher
java.io.IOException
public void search(Weight weight, Filter filter, HitCollector results) throws java.io.IOException
Searchable
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.
search
in interface Searchable
search
in class Searcher
weight
- to match documentsfilter
- if non-null, a bitset used to eliminate some documentsresults
- to receive hits
java.io.IOException
public Query rewrite(Query original) throws java.io.IOException
Searchable
rewrite
in interface Searchable
rewrite
in class Searcher
java.io.IOException
public Explanation explain(Weight weight, int doc) throws java.io.IOException
Searchable
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)
.
explain
in interface Searchable
explain
in class Searcher
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |