Lucene++ - a full-featured, c++ search engine
API Documentation
Represents hits returned by Searcher#search(QueryPtr, FilterPtr, int32_t)
and Searcher#search(QueryPtr, int32_t)
.
More...
#include <TopDocs.h>
Public Member Functions | |
TopDocs (int32_t totalHits, Collection< ScoreDocPtr > scoreDocs) | |
Constructs a TopDocs with a default maxScore = double.NaN. | |
TopDocs (int32_t totalHits, Collection< ScoreDocPtr > scoreDocs, double maxScore) | |
Constructs a TopDocs. | |
virtual | ~TopDocs () |
virtual String | getClassName () |
boost::shared_ptr< TopDocs > | shared_from_this () |
double | getMaxScore () |
Returns the maximum score value encountered. Note that in case scores are not tracked, this returns NaN. | |
void | setMaxScore (double maxScore) |
Sets the maximum score value encountered. | |
![]() | |
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 () |
Data Fields | |
int32_t | totalHits |
The total number of hits for the query. | |
Collection< ScoreDocPtr > | scoreDocs |
The top hits for the query. | |
double | maxScore |
Stores the maximum score value encountered, needed for normalizing. | |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Represents hits returned by Searcher#search(QueryPtr, FilterPtr, int32_t)
and Searcher#search(QueryPtr, int32_t)
.
Lucene::TopDocs::TopDocs | ( | int32_t | totalHits, |
Collection< ScoreDocPtr > | scoreDocs | ||
) |
Constructs a TopDocs with a default maxScore = double.NaN.
Lucene::TopDocs::TopDocs | ( | int32_t | totalHits, |
Collection< ScoreDocPtr > | scoreDocs, | ||
double | maxScore | ||
) |
Constructs a TopDocs.
|
virtual |
|
inlinestatic |
|
inlinevirtual |
Reimplemented in Lucene::TopFieldDocs.
double Lucene::TopDocs::getMaxScore | ( | ) |
Returns the maximum score value encountered. Note that in case scores are not tracked, this returns NaN.
void Lucene::TopDocs::setMaxScore | ( | double | maxScore | ) |
Sets the maximum score value encountered.
|
inline |
double Lucene::TopDocs::maxScore |
Stores the maximum score value encountered, needed for normalizing.
Collection<ScoreDocPtr> Lucene::TopDocs::scoreDocs |
The top hits for the query.
int32_t Lucene::TopDocs::totalHits |
The total number of hits for the query.