BrassDocument Class Reference

A document read from a BrassDatabase. More...

#include <brass_document.h>

Inheritance diagram for BrassDocument:

[legend]

Collaboration diagram for BrassDocument:

[legend]

List of all members.

Public Member Functions
string	do_get_value (Xapian::valueno slot) const
	Implementation of virtual methods.
void	do_get_all_values (map< Xapian::valueno, string > &values_) const
	Retrieve all value values from the database.
string	do_get_data () const
	Retrieve the document data from the database.
Private Member Functions
void	operator= (const BrassDocument &)
	Don't allow assignment.
	BrassDocument (const BrassDocument &)
	Don't allow copying.
	BrassDocument (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > db, Xapian::docid did_, const BrassValueManager *value_manager_, const BrassRecordTable *record_table_)
	Private constructor - only called by BrassDatabase::open_document().
Private Attributes
const BrassValueManager *	value_manager
	Used for lazy access to document values.
const BrassRecordTable *	record_table
	Used for lazy access to document data.
Friends
class	BrassDatabase
	BrassDatabase::open_document() needs to call our private constructor.

---

Detailed Description

A document read from a BrassDatabase.

Definition at line 30 of file brass_document.h.

---

Constructor & Destructor Documentation

BrassDocument::BrassDocument

(

const BrassDocument &

)

[private]

Don't allow copying.

BrassDocument::BrassDocument	(	Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	db,
		Xapian::docid	did_,
		const BrassValueManager *	value_manager_,
		const BrassRecordTable *	record_table_
	)			[inline, private]

Private constructor - only called by BrassDatabase::open_document().

Definition at line 47 of file brass_document.h.

---

Member Function Documentation

void BrassDocument::do_get_all_values

(

map< Xapian::valueno, string > &

values_

)

const [virtual]

Retrieve all value values from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 46 of file brass_document.cc.

References Xapian::Document::Internal::did, BrassValueManager::get_all_values(), LOGCALL_VOID, and value_manager.

string BrassDocument::do_get_data

(

)

const [virtual]

Retrieve the document data from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 55 of file brass_document.cc.

References Xapian::Document::Internal::did, BrassRecordTable::get_record(), LOGCALL, record_table, and RETURN.

string BrassDocument::do_get_value

(

Xapian::valueno

slot

)

const [virtual]

Implementation of virtual methods.

Retrieve a value from the database.

Parameters:

slot

The value number to retrieve.

Reimplemented from Xapian::Document::Internal.

Definition at line 37 of file brass_document.cc.

References Xapian::Document::Internal::did, BrassValueManager::get_value(), LOGCALL, RETURN, and value_manager.

void BrassDocument::operator=

(

const BrassDocument &

)

[private]

Don't allow assignment.

---

Friends And Related Function Documentation

friend class BrassDatabase [friend]

BrassDatabase::open_document() needs to call our private constructor.

Definition at line 44 of file brass_document.h.

---

Member Data Documentation

const BrassRecordTable* BrassDocument::record_table [private]

Used for lazy access to document data.

Definition at line 41 of file brass_document.h.

Referenced by do_get_data().

const BrassValueManager* BrassDocument::value_manager [private]

Used for lazy access to document values.

Definition at line 38 of file brass_document.h.

Referenced by do_get_all_values(), and do_get_value().

---

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

• backends/brass/brass_document.h
• backends/brass/brass_document.cc