|
|||||||||||
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
Implements search over a single IndexReader.
Applications usually need only call the inherited Searcher.search(Query)
or Searcher.search(Query,Filter)
methods.
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(String path)
Creates a searcher searching the index in the named directory. |
Method Summary | |
void |
close()
Frees resources associated with this Searcher. |
Document |
doc(int i)
For use by HitCollector implementations. |
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 . |
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)
Lower-level search API. |
TopDocs |
search(Query query,
Filter filter,
int nDocs)
Expert: Low-level search implementation. |
Methods inherited from class org.apache.lucene.search.Searcher |
getSimilarity, 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(String path) throws IOException
public IndexSearcher(Directory directory) throws IOException
public IndexSearcher(IndexReader r)
Method Detail |
public void close() throws IOException
Hits
.
IOException
public int docFreq(Term term) throws IOException
term
.
Called by search code to compute term weights.
IOException
IndexReader.docFreq(Term).
public Document doc(int i) throws IOException
HitCollector
implementations.
IOException
IndexReader.document(int).
public int maxDoc() throws IOException
IOException
IndexReader.maxDoc().
public TopDocs search(Query query, Filter filter, int nDocs) throws IOException
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.
IOException
public void search(Query query, Filter filter, HitCollector results) throws IOException
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.
query
- to match documentsfilter
- if non-null, a bitset used to eliminate some documentsresults
- to receive hits
IOException
public Query rewrite(Query original) throws IOException
Searchable
IOException
public Explanation explain(Query query, int doc) throws IOException
Searchable
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.
IOException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |