FlintDocument Class Reference

A document from a Flint format database. More...

#include <flint_document.h>

Inheritance diagram for FlintDocument:

[legend]Collaboration diagram for FlintDocument:

[legend]List of all members.

Public Member Functions
	~FlintDocument ()
	Destroy a FlintDocument.
string	do_get_value (Xapian::valueno valueid) const
	Retrieve a value from the database.
map< Xapian::valueno, string >	do_get_all_values () const
	Retrieve all value values from the database.
string	do_get_data () const
	Retrieve the document data from the database.
Private Member Functions
	FlintDocument (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > database_, const FlintValueTable *value_table_, const FlintRecordTable *record_table_, Xapian::docid did_, bool lazy)
	Create a FlintDocument: this is only called by FlintDatabase::open_document().
	FlintDocument (const FlintDocument &)
FlintDocument &	operator= (const FlintDocument &)
Private Attributes
Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	database
	The database this document is in.
const FlintValueTable *	value_table
const FlintRecordTable *	record_table
Friends
class	FlintDatabase
class	FlintWritableDatabase

---

Detailed Description

A document from a Flint format database.

Definition at line 34 of file flint_document.h.

---

Constructor & Destructor Documentation

FlintDocument::FlintDocument	(	Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	database_,
		const FlintValueTable *	value_table_,
		const FlintRecordTable *	record_table_,
		Xapian::docid	did_,
		bool	lazy
	)			[private]

Create a FlintDocument: this is only called by FlintDatabase::open_document().

Definition at line 35 of file flint_document.cc.

References DEBUGCALL, Xapian::Document::Internal::did, FlintRecordTable::get_record(), and record_table.

FlintDocument::FlintDocument

(

const FlintDocument &

)

[private]

FlintDocument::~FlintDocument

(

)

Destroy a FlintDocument.

Definition at line 52 of file flint_document.cc.

References DEBUGCALL.

---

Member Function Documentation

FlintDocument& FlintDocument::operator=

(

const FlintDocument &

)

[private]

string FlintDocument::do_get_value

(

Xapian::valueno

valueid

)

const [virtual]

Retrieve a value from the database.

Parameters:

valueid

The value number to retrieve.

Reimplemented from Xapian::Document::Internal.

Definition at line 62 of file flint_document.cc.

References DEBUGCALL, Xapian::Document::Internal::did, FlintValueTable::get_value(), RETURN, and value_table.

map< Xapian::valueno, string > FlintDocument::do_get_all_values

(

)

const [virtual]

Retrieve all value values from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 73 of file flint_document.cc.

References DEBUGCALL, Xapian::Document::Internal::did, FlintValueTable::get_all_values(), and value_table.

string FlintDocument::do_get_data

(

)

const [virtual]

Retrieve the document data from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 84 of file flint_document.cc.

References DEBUGCALL, Xapian::Document::Internal::did, FlintRecordTable::get_record(), record_table, and RETURN.

---

Friends And Related Function Documentation

friend class FlintDatabase [friend]

Definition at line 35 of file flint_document.h.

friend class FlintWritableDatabase [friend]

Definition at line 36 of file flint_document.h.

---

Member Data Documentation

Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> FlintDocument::database [private]

The database this document is in.

Reimplemented from Xapian::Document::Internal.

Definition at line 38 of file flint_document.h.

const FlintValueTable* FlintDocument::value_table [private]

Definition at line 40 of file flint_document.h.

Referenced by do_get_all_values(), and do_get_value().

const FlintRecordTable* FlintDocument::record_table [private]

Definition at line 41 of file flint_document.h.

Referenced by do_get_data(), and FlintDocument().

---

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

• backends/flint/flint_document.h
• backends/flint/flint_document.cc

---