QuartzDocument Class Reference

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

#include <quartz_document.h>

Inheritance diagram for QuartzDocument:

Inheritance graph
[legend]
Collaboration diagram for QuartzDocument:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ~QuartzDocument ()
 Destroy a QuartzDocument.
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

 QuartzDocument (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > database_, const QuartzValueTable *value_table_, const QuartzRecordTable *record_table_, Xapian::docid did_, bool lazy)
 Create a QuartzDocument: this is only called by QuartzDatabase::open_document().
 QuartzDocument (const QuartzDocument &)
QuartzDocumentoperator= (const QuartzDocument &)

Private Attributes

Xapian::Internal::RefCntPtr<
const Xapian::Database::Internal
database
 The database this document is in.
const QuartzValueTablevalue_table
const QuartzRecordTablerecord_table

Friends

class QuartzDatabase
class QuartzWritableDatabase

Detailed Description

A document from a Quartz format database.

Definition at line 34 of file quartz_document.h.


Constructor & Destructor Documentation

QuartzDocument::QuartzDocument ( Xapian::Internal::RefCntPtr< const Xapian::Database::Internal database_,
const QuartzValueTable value_table_,
const QuartzRecordTable record_table_,
Xapian::docid  did_,
bool  lazy 
) [private]

Create a QuartzDocument: this is only called by QuartzDatabase::open_document().

Definition at line 35 of file quartz_document.cc.

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

QuartzDocument::QuartzDocument ( const QuartzDocument  )  [private]

QuartzDocument::~QuartzDocument (  ) 

Destroy a QuartzDocument.

Definition at line 52 of file quartz_document.cc.

References DEBUGCALL.


Member Function Documentation

QuartzDocument& QuartzDocument::operator= ( const QuartzDocument  )  [private]

string QuartzDocument::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 quartz_document.cc.

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

map< Xapian::valueno, string > QuartzDocument::do_get_all_values (  )  const [virtual]

Retrieve all value values from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 73 of file quartz_document.cc.

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

string QuartzDocument::do_get_data (  )  const [virtual]

Retrieve the document data from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 84 of file quartz_document.cc.

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


Friends And Related Function Documentation

friend class QuartzDatabase [friend]

Definition at line 35 of file quartz_document.h.

friend class QuartzWritableDatabase [friend]

Definition at line 36 of file quartz_document.h.


Member Data Documentation

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

The database this document is in.

Reimplemented from Xapian::Document::Internal.

Definition at line 38 of file quartz_document.h.

const QuartzValueTable* QuartzDocument::value_table [private]

Definition at line 40 of file quartz_document.h.

Referenced by do_get_all_values(), and do_get_value().

const QuartzRecordTable* QuartzDocument::record_table [private]

Definition at line 41 of file quartz_document.h.

Referenced by do_get_data(), and QuartzDocument().


The documentation for this class was generated from the following files:
Documentation for Xapian (version 1.0.10).
Generated on 24 Dec 2008 by Doxygen 1.5.2.