org.apache.lucene.search
public abstract class Searcher extends Object implements Searchable
Note that you can only access Hits from a Searcher as long as it is not yet closed, otherwise an IOException will be thrown.
Constructor and Description |
---|
Searcher() |
Modifier and Type | Method and Description |
---|---|
abstract void |
close()
Frees resources associated with this Searcher.
|
protected Weight |
createWeight(Query query)
creates a weight for
query |
abstract Document |
doc(int i)
Expert: Returns the stored fields of document
i . |
abstract 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)
Returns an Explanation that describes how
doc scored against
query . |
abstract Explanation |
explain(Weight weight,
int doc)
Expert: low-level implementation method
Returns an Explanation that describes how
doc scored against
weight . |
Similarity |
getSimilarity()
Expert: Return the Similarity implementation used by this Searcher.
|
abstract int |
maxDoc()
Expert: Returns one greater than the largest possible document number.
|
abstract Query |
rewrite(Query query)
Expert: called to re-write queries into primitive queries.
|
Hits |
search(Query query)
Returns the documents matching
query . |
Hits |
search(Query query,
Filter filter)
Returns the documents matching
query and
filter . |
void |
search(Query query,
Filter filter,
HitCollector results)
Lower-level search API.
|
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 with arbitrary sorting.
|
Hits |
search(Query query,
Filter filter,
Sort sort)
Returns documents matching
query and filter ,
sorted by sort . |
void |
search(Query query,
HitCollector results)
Lower-level search API.
|
Hits |
search(Query query,
Sort sort)
Returns documents matching
query sorted by
sort . |
abstract void |
search(Weight weight,
Filter filter,
HitCollector results)
Lower-level search API.
|
abstract TopDocs |
search(Weight weight,
Filter filter,
int n)
Expert: Low-level search implementation.
|
abstract TopFieldDocs |
search(Weight weight,
Filter filter,
int n,
Sort sort)
Expert: Low-level search implementation with arbitrary sorting.
|
void |
setSimilarity(Similarity similarity)
Expert: Set the Similarity implementation used by this Searcher.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
doc
public final Hits search(Query query) throws IOException
query
.public Hits search(Query query, Filter filter) throws IOException
query
and
filter
.public Hits search(Query query, Sort sort) throws IOException
query
sorted by
sort
.public Hits search(Query query, Filter filter, Sort sort) throws IOException
query
and filter
,
sorted by sort
.public TopFieldDocs search(Query query, Filter filter, int n, Sort sort) throws IOException
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,Sort)
instead.
public void search(Query query, 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 (search(Query)
) is usually more efficient, as it skips
non-high-scoring hits.
Note: The score
passed to this method is a raw score.
In other words, the score will not necessarily be a float whose value is
between 0 and 1.
public void search(Query query, Filter filter, HitCollector results) throws IOException
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 (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 hitsBooleanQuery.TooManyClauses
IOException
public TopDocs search(Query query, Filter filter, int n) throws IOException
n
hits for query
, applying filter
if non-null.
Called by Hits
.
Applications should usually call search(Query)
or
search(Query,Filter)
instead.
public Explanation explain(Query query, int doc) throws IOException
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
public void setSimilarity(Similarity similarity)
Similarity.setDefault(Similarity)
public Similarity getSimilarity()
This defaults to the current value of Similarity.getDefault()
.
protected Weight createWeight(Query query) throws IOException
query
IOException
public int[] docFreqs(Term[] terms) throws IOException
Searchable
term
. Returns an array with these
document frequencies. Used to minimize number of remote calls.docFreqs
in interface Searchable
IOException
public abstract void search(Weight weight, Filter filter, HitCollector results) throws 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 (search(Query)
) is usually more efficient, as it skips
non-high-scoring hits.
search
in interface Searchable
weight
- to match documentsfilter
- if non-null, a bitset used to eliminate some documentsresults
- to receive hitsIOException
public abstract void close() throws IOException
Searchable
Hits
.close
in interface Searchable
IOException
public abstract int docFreq(Term term) throws IOException
Searchable
term
.
Called by search code to compute term weights.docFreq
in interface Searchable
IOException
IndexReader.docFreq(Term)
public abstract int maxDoc() throws IOException
Searchable
maxDoc
in interface Searchable
IOException
IndexReader.maxDoc()
public abstract TopDocs search(Weight weight, Filter filter, int n) throws IOException
Searchable
n
hits for query
, applying filter
if non-null.
Called by Hits
.
Applications should usually call search(Query)
or
search(Query,Filter)
instead.
search
in interface Searchable
IOException
public abstract Document doc(int i) throws CorruptIndexException, IOException
Searchable
i
.
Called by HitCollector
implementations.doc
in interface Searchable
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorIndexReader.document(int)
public abstract Query rewrite(Query query) throws IOException
Searchable
rewrite
in interface Searchable
IOException
public abstract Explanation explain(Weight weight, int doc) throws 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 explain(Query, int)
.
explain
in interface Searchable
IOException
public abstract TopFieldDocs search(Weight weight, Filter filter, int n, Sort sort) throws IOException
Searchable
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,Sort)
instead.
search
in interface Searchable
IOException
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.