@Deprecated 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()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
close()
Deprecated.
Frees resources associated with this Searcher.
|
Weight |
createNormalizedWeight(Query query)
Deprecated.
Creates a normalized weight for a top-level
Query . |
protected Weight |
createWeight(Query query)
Deprecated.
never ever use this method in
Weight implementations.
Subclasses of Searcher should use createNormalizedWeight(org.apache.lucene.search.Query) , instead. |
abstract Document |
doc(int i)
Deprecated.
Returns the stored fields of document
i . |
abstract Document |
doc(int docid,
FieldSelector fieldSelector)
Deprecated.
Get the
Document at the n th position. |
abstract int |
docFreq(Term term)
Deprecated.
Expert: Returns the number of documents containing
term . |
int[] |
docFreqs(Term[] terms)
Deprecated.
Expert: For each term in the terms array, calculates the number of
documents containing
term . |
Explanation |
explain(Query query,
int doc)
Deprecated.
Returns an Explanation that describes how
doc scored against
query . |
abstract Explanation |
explain(Weight weight,
int doc)
Deprecated.
Expert: low-level implementation method
Returns an Explanation that describes how
doc scored against
weight . |
Similarity |
getSimilarity()
Deprecated.
Expert: Return the Similarity implementation used by this Searcher.
|
abstract int |
maxDoc()
Deprecated.
Expert: Returns one greater than the largest possible document number.
|
abstract Query |
rewrite(Query query)
Deprecated.
Expert: called to re-write queries into primitive queries.
|
void |
search(Query query,
Collector results)
Deprecated.
Lower-level search API.
|
void |
search(Query query,
Filter filter,
Collector results)
Deprecated.
Lower-level search API.
|
TopDocs |
search(Query query,
Filter filter,
int n)
Deprecated.
Finds the top
n
hits for query , applying filter if non-null. |
TopFieldDocs |
search(Query query,
Filter filter,
int n,
Sort sort)
Deprecated.
Search implementation with arbitrary sorting.
|
TopDocs |
search(Query query,
int n)
Deprecated.
Finds the top
n
hits for query . |
TopFieldDocs |
search(Query query,
int n,
Sort sort)
Deprecated.
Search implementation with arbitrary sorting and no filter.
|
abstract void |
search(Weight weight,
Filter filter,
Collector results)
Deprecated.
Lower-level search API.
|
abstract TopDocs |
search(Weight weight,
Filter filter,
int n)
Deprecated.
Expert: Low-level search implementation.
|
abstract TopFieldDocs |
search(Weight weight,
Filter filter,
int n,
Sort sort)
Deprecated.
Expert: Low-level search implementation with arbitrary sorting.
|
void |
setSimilarity(Similarity similarity)
Deprecated.
Expert: Set the Similarity implementation used by this Searcher.
|
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
.
NOTE: this does not compute scores by default; use
IndexSearcher.setDefaultFieldSortScoring(boolean, boolean)
to
enable scoring.
public TopFieldDocs search(Query query, int n, Sort sort) throws IOException
query
- The query to search forn
- Return only the top n resultssort
- The Sort
objectSort
instanceIOException
public void search(Query query, Collector results) throws IOException
Collector.collect(int)
is called for every matching document.
Applications should only use this if they need all of the
matching documents. The high-level search API (search(Query, int)
) 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, Collector results) throws IOException
Collector.collect(int)
is called for every matching
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 (search(Query, Filter, int)
) is usually more efficient, as it skips
non-high-scoring hits.
query
- to match documentsfilter
- if non-null, used to permit documents to be collected.results
- 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.public TopDocs search(Query query, int n) throws IOException
n
hits for query
.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()
.
public Weight createNormalizedWeight(Query query) throws IOException
Query
.
The query is rewritten by this method and Query.createWeight(org.apache.lucene.search.Searcher)
called,
afterwards the Weight
is normalized. The returned Weight
can then directly be used to get a Scorer
.IOException
@Deprecated protected final Weight createWeight(Query query) throws IOException
Weight
implementations.
Subclasses of Searcher should use createNormalizedWeight(org.apache.lucene.search.Query)
, instead.Query
.
The query is rewritten by this method and Query.createWeight(org.apache.lucene.search.Searcher)
called,
afterwards the Weight
is normalized. The returned Weight
can then directly be used to get a Scorer
.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, Collector results) throws IOException
Searchable
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 (search(Query,int)
) is
usually more efficient, as it skips non-high-scoring hits.
search
in interface Searchable
weight
- to match documentsfilter
- if non-null, used to permit documents to be collected.results
- to receive hitsIOException
public abstract void close() throws IOException
Searchable
close
in interface Closeable
close
in interface Searchable
IOException
public abstract int docFreq(Term term) throws IOException
Searchable
term
.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.
Applications should usually call search(Query,int)
or
search(Query,Filter,int)
instead.
search
in interface Searchable
IOException
public abstract Document doc(int i) throws CorruptIndexException, IOException
Searchable
i
.doc
in interface Searchable
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorIndexReader.document(int)
public abstract Document doc(int docid, FieldSelector fieldSelector) throws CorruptIndexException, IOException
Searchable
Document
at the n
th position. The FieldSelector
may be used to determine what Field
s to load and how they should be loaded.
NOTE: If the underlying Reader (more specifically, the underlying FieldsReader
) is closed before the lazy Field
is
loaded an exception may be thrown. If you want the value of a lazy Field
to be available after closing you must
explicitly load it or fetch the Document again with a new loader.doc
in interface Searchable
docid
- Get the document at the n
th positionfieldSelector
- The FieldSelector
to use to determine what Fields should be loaded on the Document. May be null, in which case all Fields will be loaded.Document
at the nth positionCorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorIndexReader.document(int, FieldSelector)
,
Fieldable
,
FieldSelector
,
SetBasedFieldSelector
,
LoadFirstFieldSelector
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,int,Sort)
instead.
search
in interface Searchable
IOException