lucene::search::Explanation Class Reference
#include <Explanation.h>
List of all members.
Constructor & Destructor Documentation
| lucene::search::Explanation::Explanation |
( |
const Explanation & |
copy |
) |
[protected] |
| lucene::search::Explanation::Explanation |
( |
|
) |
|
| lucene::search::Explanation::~Explanation |
( |
|
) |
|
| lucene::search::Explanation::Explanation |
( |
float_t |
value, |
|
|
const TCHAR * |
description | |
|
) |
| | |
Member Function Documentation
| void lucene::search::Explanation::addDetail |
( |
Explanation * |
detail |
) |
|
Adds a sub-node to this explanation node.
| Explanation* lucene::search::Explanation::clone |
( |
|
) |
const |
| const TCHAR* lucene::search::Explanation::getDescription |
( |
|
) |
const |
A description of this explanation node.
returns reference
| Explanation* lucene::search::Explanation::getDetail |
( |
int |
i |
) |
|
| void lucene::search::Explanation::getDetails |
( |
Explanation ** |
ret |
) |
|
The sub-nodes of this explanation node.
- Parameters:
-
| ret | this array of Explanations should be getDetailsLength()+1 in size. The array will be null terminated. |
| int lucene::search::Explanation::getDetailsLength |
( |
|
) |
|
| float_t lucene::search::Explanation::getValue |
( |
|
) |
const |
The value assigned to this explanation node.
| void lucene::search::Explanation::set |
( |
const Explanation & |
other |
) |
|
| void lucene::search::Explanation::setDescription |
( |
const TCHAR * |
description |
) |
|
Sets the description of this explanation node.
| void lucene::search::Explanation::setValue |
( |
float_t |
value |
) |
|
Sets the value assigned to this explanation node.
| TCHAR* lucene::search::Explanation::toHtml |
( |
|
) |
|
Render an explanation as HTML.
| TCHAR* lucene::search::Explanation::toString |
( |
|
) |
|
Render an explanation as text.
The documentation for this class was generated from the following file:
