lucene::search::Explanation Class Reference

#include <Explanation.h>

Public Member Functions
	Explanation ()
	~Explanation ()
	Explanation (float_t value, const TCHAR *description)
void	set (const Explanation &other)
Explanation *	clone () const
float_t	getValue () const
	The value assigned to this explanation node.
void	setValue (float_t value)
	Sets the value assigned to this explanation node.
const TCHAR *	getDescription () const
	A description of this explanation node.
void	setDescription (const TCHAR *description)
	Sets the description of this explanation node.
void	getDetails (Explanation **ret)
	The sub-nodes of this explanation node.
int	getDetailsLength ()
Explanation *	getDetail (int i)
void	addDetail (Explanation *detail)
	Adds a sub-node to this explanation node.
TCHAR *	toString ()
	Render an explanation as text.
TCHAR *	toHtml ()
	Render an explanation as HTML.
Protected Member Functions
	Explanation (const Explanation &copy)

---

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::set

(

const Explanation &

other

)

Explanation* lucene::search::Explanation::clone

(

)

const

float_t lucene::search::Explanation::getValue

(

)

const

The value assigned to this explanation node.

void lucene::search::Explanation::setValue

(

float_t

value

)

Sets the value assigned to this explanation node.

const TCHAR* lucene::search::Explanation::getDescription

(

)

const

A description of this explanation node.

returns reference

void lucene::search::Explanation::setDescription

(

const TCHAR *

description

)

Sets the description of this explanation node.

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

(

)

Explanation* lucene::search::Explanation::getDetail

(

int

i

)

void lucene::search::Explanation::addDetail

(

Explanation *

detail

)

Adds a sub-node to this explanation node.

TCHAR* lucene::search::Explanation::toString

(

)

Render an explanation as text.

TCHAR* lucene::search::Explanation::toHtml

(

)

Render an explanation as HTML.

---

The documentation for this class was generated from the following file:

• Explanation.h