java.lang.Object | |
↳ | org.apache.lucene.search.Searcher |
Known Direct Subclasses |
Known Indirect Subclasses |
An abstract base class for search implementations. Implements the main search methods.
Note that you can only access hits from a Searcher as long as it is not yet closed, otherwise an IOException will be thrown.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Frees resources associated with this Searcher.
| |||||||||||
Returns the stored fields of document
i . | |||||||||||
Get the
Document at the n th position. | |||||||||||
Expert: Returns the number of documents containing
term . | |||||||||||
Expert: For each term in the terms array, calculates the number of
documents containing
term . | |||||||||||
Returns an Explanation that describes how
doc scored against
query . | |||||||||||
Expert: low-level implementation method
Returns an Explanation that describes how
doc scored against
weight . | |||||||||||
Expert: Return the Similarity implementation used by this Searcher.
| |||||||||||
Expert: Returns one greater than the largest possible document number.
| |||||||||||
Expert: called to re-write queries into primitive queries.
| |||||||||||
Finds the top
n
hits for query . | |||||||||||
Lower-level search API.
| |||||||||||
Lower-level search API.
| |||||||||||
Search implementation with arbitrary sorting.
| |||||||||||
Lower-level search API.
| |||||||||||
Finds the top
n
hits for query , applying filter if non-null. | |||||||||||
Expert: Low-level search implementation.
| |||||||||||
Expert: Low-level search implementation with arbitrary sorting.
| |||||||||||
Expert: Set the Similarity implementation used by this Searcher.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
creates a weight for
query |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
| |||||||||||
From interface
org.apache.lucene.search.Searchable
|
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.
IOException |
---|
Returns the stored fields of document i
.
CorruptIndexException | |
---|---|
IOException |
Get the 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.
docid | Get the document at the n th position |
---|---|
fieldSelector | 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 | |
---|---|
IOException |
Expert: Returns the number of documents containing term
.
IOException |
---|
Expert: For each term in the terms array, calculates the number of
documents containing term
. Returns an array with these
document frequencies. Used to minimize number of remote calls.
IOException |
---|
Returns an Explanation that describes how 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 |
---|
Expert: low-level implementation method
Returns an Explanation that describes how 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)
.
IOException |
---|
Expert: Return the Similarity implementation used by this Searcher.
This defaults to the current value of getDefault()
.
Expert: Returns one greater than the largest possible document number.
IOException |
---|
Expert: called to re-write queries into primitive queries.
IOException |
---|
Lower-level search API.
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.
weight | to match documents |
---|---|
filter | if non-null, used to permit documents to be collected. |
results | to receive hits |
IOException |
---|
Lower-level search API.
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 documents |
---|---|
filter | if non-null, used to permit documents to be collected. |
results | to receive hits |
Search implementation with arbitrary sorting. Finds
the top 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
setDefaultFieldSortScoring(boolean, boolean)
to
enable scoring.
Lower-level search API.
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.
Finds the top n
hits for query
, applying filter
if non-null.
Expert: Low-level search implementation. Finds the top n
hits for query
, applying filter
if non-null.
Applications should usually call search(Query, int)
or
search(Query, Filter, int)
instead.
IOException |
---|
Expert: Low-level search implementation with arbitrary sorting. Finds
the top 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.
IOException |
---|
Expert: Set the Similarity implementation used by this Searcher.