Lucene++ - a full-featured, c++ search engine
API Documentation
Describes the score computation for document and query. More...
#include <Explanation.h>
Public Member Functions | |
Explanation (double value=0, const String &description=EmptyString) | |
virtual | ~Explanation () |
virtual String | getClassName () |
boost::shared_ptr< Explanation > | shared_from_this () |
virtual bool | isMatch () |
Indicates whether or not this Explanation models a good match. | |
virtual double | getValue () |
The value assigned to this explanation node. | |
virtual void | setValue (double value) |
Sets the value assigned to this explanation node. | |
virtual String | getDescription () |
A description of this explanation node. | |
virtual void | setDescription (const String &description) |
Sets the description of this explanation node. | |
virtual Collection< ExplanationPtr > | getDetails () |
The sub-nodes of this explanation node. | |
virtual void | addDetail (const ExplanationPtr &detail) |
Adds a sub-node to this explanation node. | |
virtual String | toString () |
Render an explanation as text. | |
virtual String | toHtml () |
Render an explanation as HTML. | |
![]() | |
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 | ~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 () |
Protected Member Functions | |
virtual String | getSummary () |
A short one line summary which should contain all high level information about this Explanation, without the "Details". | |
virtual String | toString (int32_t depth) |
![]() | |
LuceneObject () | |
Protected Attributes | |
double | value |
String | description |
Collection< ExplanationPtr > | details |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Describes the score computation for document and query.
Lucene::Explanation::Explanation | ( | double | value = 0 , |
const String & | description = EmptyString |
||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Adds a sub-node to this explanation node.
|
inlinevirtual |
Reimplemented in Lucene::ComplexExplanation.
|
virtual |
A description of this explanation node.
|
virtual |
The sub-nodes of this explanation node.
|
protectedvirtual |
A short one line summary which should contain all high level information about this Explanation, without the "Details".
Reimplemented in Lucene::ComplexExplanation.
|
virtual |
The value assigned to this explanation node.
|
virtual |
Indicates whether or not this Explanation models a good match.
By default, an Explanation represents a "match" if the value is positive.
Reimplemented in Lucene::ComplexExplanation.
|
virtual |
Sets the description of this explanation node.
|
virtual |
Sets the value assigned to this explanation node.
|
inline |
|
virtual |
Render an explanation as HTML.
|
virtual |
Render an explanation as text.
Reimplemented from Lucene::LuceneObject.
|
protectedvirtual |
|
protected |
|
protected |
|
protected |