Lucene++ - a full-featured, c++ search engine
API Documentation
The interface for search implementations. More...
#include <Searchable.h>
Public Member Functions | |
virtual String | getClassName () |
virtual | ~Searchable () |
virtual void | search (const WeightPtr &weight, const FilterPtr &filter, const CollectorPtr &collector)=0 |
Lower-level search API. | |
virtual void | close ()=0 |
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable. | |
virtual int32_t | docFreq (const TermPtr &term)=0 |
Returns the number of documents containing term. | |
virtual Collection< int32_t > | docFreqs (Collection< TermPtr > terms)=0 |
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. | |
virtual int32_t | maxDoc ()=0 |
Returns one greater than the largest possible document number. | |
virtual TopDocsPtr | search (const WeightPtr &weight, const FilterPtr &filter, int32_t n)=0 |
Low-level search implementation. Finds the top n hits for query, applying filter if non-null. Applications should usually call Searcher#search(QueryPtr, int32_t) or Searcher#search(QueryPtr, FilterPtr, int32_t) instead. | |
virtual DocumentPtr | doc (int32_t n)=0 |
Returns the stored fields of document i. | |
virtual DocumentPtr | doc (int32_t n, const FieldSelectorPtr &fieldSelector)=0 |
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. | |
virtual QueryPtr | rewrite (const QueryPtr &query)=0 |
Called to re-write queries into primitive queries. | |
virtual ExplanationPtr | explain (const WeightPtr &weight, int32_t doc)=0 |
Low-level implementation method. Returns an Explanation that describes how doc scored against weight. | |
virtual TopFieldDocsPtr | search (const WeightPtr &weight, const FilterPtr &filter, int32_t n, const SortPtr &sort)=0 |
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. | |
Static Public Member Functions | |
static String | _getClassName () |
The interface for search implementations.
Searchable is the abstract network protocol for searching. Implementations provide search over a single index, over multiple indices, and over indices on remote servers.
Queries, filters and sort criteria are designed to be compact so that they may be efficiently passed to a remote index, with only the top-scoring hits being returned, rather than every matching hit.
NOTE: this interface is kept public for convenience. Since it is not expected to be implemented directly, it may be changed unexpectedly between releases.
|
inlinevirtual |
|
inlinestatic |
|
pure virtual |
Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
|
pure virtual |
Returns the stored fields of document i.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
|
pure virtual |
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.
n | 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 n'th positionImplemented in Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
|
pure virtual |
Returns the number of documents containing term.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, Lucene::ParallelMultiSearcher, and Lucene::Searcher.
|
pure virtual |
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.
Implemented in Lucene::Searcher.
|
pure virtual |
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 Searcher#explain(QueryPtr, int32_t)
.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, Lucene::IndexSearcher, and Lucene::Searcher.
|
inlinevirtual |
Reimplemented in Lucene::IndexSearcher, Lucene::MultiSearcher, Lucene::ParallelMultiSearcher, and Lucene::Searcher.
|
pure virtual |
Returns one greater than the largest possible document number.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
Called to re-write queries into primitive queries.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
|
pure virtual |
Lower-level search API.
Collector#collect(int32_t)
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 (Searcher#search(QueryPtr, int32_t)
) 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. |
collector | To receive hits |
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
|
pure virtual |
Low-level search implementation. Finds the top n hits for query, applying filter if non-null. Applications should usually call Searcher#search(QueryPtr, int32_t)
or Searcher#search(QueryPtr, FilterPtr, int32_t)
instead.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, Lucene::ParallelMultiSearcher, Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.
|
pure virtual |
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 Searcher#search(QueryPtr, FilterPtr, int32_t, SortPtr)
instead.
Implemented in Lucene::IndexSearcher, Lucene::MultiSearcher, Lucene::ParallelMultiSearcher, Lucene::IndexSearcher, Lucene::MultiSearcher, and Lucene::Searcher.