Lucene++ - a full-featured, c++ search engine
API Documentation
Implements search over a single IndexReader. More...
#include <IndexSearcher.h>
Public Member Functions | |
IndexSearcher (const DirectoryPtr &path, bool readOnly=true) | |
Creates a searcher searching the index in the named directory. You should pass readOnly = true, since it gives much better concurrent performance, unless you intend to do write operations (delete documents or change norms) with the underlying IndexReader. | |
IndexSearcher (const IndexReaderPtr &reader) | |
Creates a searcher searching the provided index. | |
IndexSearcher (const IndexReaderPtr &reader, Collection< IndexReaderPtr > subReaders, Collection< int32_t > docStarts) | |
Directly specify the reader, subReaders and their docID starts. | |
virtual | ~IndexSearcher () |
virtual String | getClassName () |
boost::shared_ptr< IndexSearcher > | shared_from_this () |
IndexReaderPtr | getIndexReader () |
Return the IndexReader this searches. | |
virtual void | close () |
Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(const IndexReaderPtr& reader). If the IndexReader was supplied implicitly by specifying a directory, then the IndexReader gets closed. | |
virtual int32_t | docFreq (const TermPtr &term) |
Returns the number of documents containing term. | |
virtual DocumentPtr | doc (int32_t n) |
Returns the stored fields of document i. | |
virtual DocumentPtr | doc (int32_t n, const FieldSelectorPtr &fieldSelector) |
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 int32_t | maxDoc () |
Returns one greater than the largest possible document number. | |
virtual TopDocsPtr | search (const WeightPtr &weight, const FilterPtr &filter, int32_t n) |
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 TopFieldDocsPtr | search (const WeightPtr &weight, const FilterPtr &filter, int32_t n, const SortPtr &sort) |
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. | |
virtual TopFieldDocsPtr | search (const WeightPtr &weight, const FilterPtr &filter, int32_t n, const SortPtr &sort, bool fillFields) |
Just like search(WeightPtr, FilterPtr, int32_t, SortPtr) , but you choose whether or not the fields in the returned FieldDoc instances should be set by specifying fillFields. | |
virtual void | search (const WeightPtr &weight, const FilterPtr &filter, const CollectorPtr &results) |
Lower-level search API. | |
virtual QueryPtr | rewrite (const QueryPtr &query) |
Called to re-write queries into primitive queries. | |
virtual ExplanationPtr | explain (const WeightPtr &weight, int32_t doc) |
Low-level implementation method. Returns an Explanation that describes how doc scored against weight. | |
virtual void | setDefaultFieldSortScoring (bool doTrackScores, bool doMaxScore) |
By default, no scores are computed when sorting by field (using search(QueryPtr, FilterPtr,
int32_t, SortPtr) ). You can change that, per IndexSearcher instance, by calling this method. Note that this will incur a CPU cost. | |
virtual TopFieldDocsPtr | search (const QueryPtr &query, const FilterPtr &filter, int32_t n, const SortPtr &sort) |
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. | |
virtual void | search (const QueryPtr &query, const CollectorPtr &results) |
Lower-level search API. | |
virtual void | search (const QueryPtr &query, const FilterPtr &filter, const CollectorPtr &results) |
Lower-level search API. | |
virtual TopDocsPtr | search (const QueryPtr &query, const FilterPtr &filter, int32_t n) |
Finds the top n hits for query, applying filter if non-null. | |
virtual TopDocsPtr | search (const QueryPtr &query, int32_t n) |
Finds the top n hits for query. | |
virtual void | search (const WeightPtr &weight, const FilterPtr &filter, const CollectorPtr &results)=0 |
Lower-level search API. | |
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 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. | |
virtual ExplanationPtr | explain (const QueryPtr &query, int32_t doc) |
Returns an Explanation that describes how doc scored against query. | |
virtual ExplanationPtr | explain (const WeightPtr &weight, int32_t doc)=0 |
Low-level implementation method. Returns an Explanation that describes how doc scored against weight. | |
![]() | |
Searcher () | |
virtual | ~Searcher () |
boost::shared_ptr< Searcher > | shared_from_this () |
virtual void | setSimilarity (const SimilarityPtr &similarity) |
Set the Similarity implementation used by this Searcher. | |
virtual SimilarityPtr | getSimilarity () |
Return the Similarity implementation used by this Searcher. | |
virtual Collection< int32_t > | docFreqs (Collection< TermPtr > terms) |
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 | ~Searchable () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Data Fields | |
IndexReaderPtr | reader |
Protected Member Functions | |
void | ConstructSearcher (const IndexReaderPtr &reader, bool closeReader) |
void | gatherSubReaders (Collection< IndexReaderPtr > allSubReaders, const IndexReaderPtr &reader) |
void | searchWithFilter (const IndexReaderPtr &reader, const WeightPtr &weight, const FilterPtr &filter, const CollectorPtr &collector) |
![]() | |
virtual WeightPtr | createWeight (const QueryPtr &query) |
Creates a weight for query. | |
![]() | |
LuceneObject () | |
Protected Attributes | |
bool | closeReader |
Collection< IndexReaderPtr > | subReaders |
Collection< int32_t > | docStarts |
bool | fieldSortDoTrackScores |
bool | fieldSortDoMaxScore |
![]() | |
SimilarityPtr | similarity |
The Similarity implementation used by this searcher. | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Implements search over a single IndexReader.
Applications usually need only call the inherited search(QueryPtr, int32_t)
or search(QueryPtr, FilterPtr, int32_t)
methods. For performance reasons it is recommended to open only one IndexSearcher and use it for all of your searches.
NOTE: IndexSearcher
instances are completely thread safe, meaning multiple threads can call any of its methods, concurrently. If your application requires external synchronization, you should not synchronize on the IndexSearcher instance; use your own (non-Lucene) objects instead.
Lucene::IndexSearcher::IndexSearcher | ( | const DirectoryPtr & | path, |
bool | readOnly = true |
||
) |
Creates a searcher searching the index in the named directory. You should pass readOnly = true, since it gives much better concurrent performance, unless you intend to do write operations (delete documents or change norms) with the underlying IndexReader.
path | Directory where IndexReader will be opened |
readOnly | If true, the underlying IndexReader will be opened readOnly |
Lucene::IndexSearcher::IndexSearcher | ( | const IndexReaderPtr & | reader | ) |
Creates a searcher searching the provided index.
Lucene::IndexSearcher::IndexSearcher | ( | const IndexReaderPtr & | reader, |
Collection< IndexReaderPtr > | subReaders, | ||
Collection< int32_t > | docStarts | ||
) |
Directly specify the reader, subReaders and their docID starts.
|
virtual |
|
inlinestatic |
|
virtual |
Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(const IndexReaderPtr& reader). If the IndexReader was supplied implicitly by specifying a directory, then the IndexReader gets closed.
Implements Lucene::Searcher.
|
protected |
|
virtual |
Returns the stored fields of document i.
Implements Lucene::Searcher.
|
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 positionImplements Lucene::Searcher.
|
virtual |
Returns the number of documents containing term.
Implements Lucene::Searcher.
|
virtual |
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.
Reimplemented from Lucene::Searcher.
|
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)
.
Implements Lucene::Searcher.
|
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)
.
Implements Lucene::Searcher.
|
protected |
|
inlinevirtual |
Reimplemented from Lucene::Searcher.
IndexReaderPtr Lucene::IndexSearcher::getIndexReader | ( | ) |
Return the IndexReader
this searches.
|
virtual |
Returns one greater than the largest possible document number.
Implements Lucene::Searcher.
Called to re-write queries into primitive queries.
Implements Lucene::Searcher.
|
virtual |
Lower-level search API.
Collector#collect(int32_t)
is called for every matching document.
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.
Note: The score passed to this method is a raw score. In other words, the score will not necessarily be a double whose value is between 0 and 1.
Reimplemented from Lucene::Searcher.
|
virtual |
Lower-level search API.
Collector#collect(int32_t)
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 (Searcher#search(QueryPtr, FilterPtr, int32_t)
) 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 |
Reimplemented from Lucene::Searcher.
|
virtual |
Finds the top n hits for query, applying filter if non-null.
Reimplemented from Lucene::Searcher.
|
virtual |
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 IndexSearcher#setDefaultFieldSortScoring
to enable scoring.
Reimplemented from Lucene::Searcher.
|
virtual |
Finds the top n hits for query.
Reimplemented from Lucene::Searcher.
|
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 |
Implements Lucene::Searcher.
|
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 |
Implements Lucene::Searcher.
|
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.
Implements Lucene::Searcher.
|
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.
Implements Lucene::Searcher.
|
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.
Implements Lucene::Searcher.
|
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.
Implements Lucene::Searcher.
|
virtual |
Just like search(WeightPtr, FilterPtr, int32_t, SortPtr)
, but you choose whether or not the fields in the returned FieldDoc
instances should be set by specifying fillFields.
NOTE: this does not compute scores by default. If you need scores, create a TopFieldCollector
instance by calling TopFieldCollector#create
and then pass that to search(WeightPtr,
FilterPtr, CollectorPtr)
.
|
protected |
|
virtual |
By default, no scores are computed when sorting by field (using search(QueryPtr, FilterPtr,
int32_t, SortPtr)
). You can change that, per IndexSearcher instance, by calling this method. Note that this will incur a CPU cost.
doTrackScores | If true, then scores are returned for every matching document in TopFieldDocs . |
doMaxScore | If true, then the max score for all matching docs is computed. |
|
inline |
|
protected |
|
protected |
|
protected |
|
protected |
IndexReaderPtr Lucene::IndexSearcher::reader |
|
protected |