|
| 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. More...
|
|
| IndexSearcher (const IndexReaderPtr &reader) |
| Creates a searcher searching the provided index. More...
|
|
| IndexSearcher (const IndexReaderPtr &reader, Collection< IndexReaderPtr > subReaders, Collection< int32_t > docStarts) |
| Directly specify the reader, subReaders and their docID starts. More...
|
|
virtual | ~IndexSearcher () |
|
virtual String | getClassName () |
|
boost::shared_ptr< IndexSearcher > | shared_from_this () |
|
IndexReaderPtr | getIndexReader () |
| Return the IndexReader this searches. More...
|
|
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. More...
|
|
virtual int32_t | docFreq (const TermPtr &term) |
| Returns the number of documents containing term. More...
|
|
virtual DocumentPtr | doc (int32_t n) |
| Returns the stored fields of document i. More...
|
|
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 Fields to load and how they should be loaded. More...
|
|
virtual int32_t | maxDoc () |
| Returns one greater than the largest possible document number. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
virtual void | search (const WeightPtr &weight, const FilterPtr &filter, const CollectorPtr &results) |
| Lower-level search API. More...
|
|
virtual QueryPtr | rewrite (const QueryPtr &query) |
| Called to re-write queries into primitive queries. More...
|
|
virtual ExplanationPtr | explain (const WeightPtr &weight, int32_t doc) |
| Low-level implementation method. Returns an Explanation that describes how doc scored against weight. More...
|
|
virtual void | setDefaultFieldSortScoring (bool doTrackScores, bool doMaxScore) |
| By default, no scores are computed when sorting by field (using FilterPtr, int32_t, SortPtr)). You can change that, per IndexSearcher instance, by calling this method. Note that this will incur a CPU cost. More...
|
|
| Searcher () |
|
virtual | ~Searcher () |
|
boost::shared_ptr< Searcher > | shared_from_this () |
|
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. More...
|
|
virtual void | search (const QueryPtr &query, const CollectorPtr &results) |
| Lower-level search API. More...
|
|
virtual void | search (const QueryPtr &query, const FilterPtr &filter, const CollectorPtr &results) |
| Lower-level search API. More...
|
|
virtual TopDocsPtr | search (const QueryPtr &query, const FilterPtr &filter, int32_t n) |
| Finds the top n hits for query, applying filter if non-null. More...
|
|
virtual TopDocsPtr | search (const QueryPtr &query, int32_t n) |
| Finds the top n hits for query. More...
|
|
virtual ExplanationPtr | explain (const QueryPtr &query, int32_t doc) |
| Returns an Explanation that describes how doc scored against query. More...
|
|
virtual void | setSimilarity (const SimilarityPtr &similarity) |
| Set the Similarity implementation used by this Searcher. More...
|
|
virtual SimilarityPtr | getSimilarity () |
| Return the Similarity implementation used by this Searcher. More...
|
|
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. More...
|
|
virtual | ~LuceneObject () |
|
virtual void | initialize () |
| Called directly after instantiation to create objects that depend on this object being fully constructed. More...
|
|
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
| Return clone of this object. More...
|
|
virtual int32_t | hashCode () |
| Return hash code for this object. More...
|
|
virtual bool | equals (const LuceneObjectPtr &other) |
| Return whether two objects are equal. More...
|
|
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
| Compare two objects. More...
|
|
virtual String | toString () |
| Returns a string representation of the object. More...
|
|
virtual | ~LuceneSync () |
|
virtual SynchronizePtr | getSync () |
| Return this object synchronize lock. More...
|
|
virtual LuceneSignalPtr | getSignal () |
| Return this object signal. More...
|
|
virtual void | lock (int32_t timeout=0) |
| Lock this object using an optional timeout. More...
|
|
virtual void | unlock () |
| Unlock this object. More...
|
|
virtual bool | holdsLock () |
| Returns true if this object is currently locked by current thread. More...
|
|
virtual void | wait (int32_t timeout=0) |
| Wait for signal using an optional timeout. More...
|
|
virtual void | notifyAll () |
| Notify all threads waiting for signal. More...
|
|
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.