FlintRecordTable Class Reference

A record in a flint database. More...

#include <flint_record.h>

Inheritance diagram for FlintRecordTable:

Inheritance graph
[legend]
Collaboration diagram for FlintRecordTable:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FlintRecordTable (string path_, bool readonly_)
 Create a new table object.
string get_record (Xapian::docid did) const
 Retrieve a document from the table.
Xapian::doccount get_doccount () const
 Get the number of records in the table.
void replace_record (const string &data, Xapian::docid did)
void delete_record (Xapian::docid did)
 Delete a record from the table.

Detailed Description

A record in a flint database.

Definition at line 36 of file flint_record.h.


Constructor & Destructor Documentation

FlintRecordTable::FlintRecordTable ( string  path_,
bool  readonly_ 
) [inline]

Create a new table object.

This does not create the table on disk - the create() method must be called before the table is created on disk

This also does not open the table - the open() method must be called before use is made of the table.

Parameters:
path_ - Path at which the table is stored.
readonly_ - whether to open the table for read only access.

Definition at line 50 of file flint_record.h.


Member Function Documentation

string FlintRecordTable::get_record ( Xapian::docid  did  )  const

Retrieve a document from the table.

Definition at line 36 of file flint_record.cc.

References DEBUGCALL, flint_docid_to_key(), FlintTable::get_exact_entry(), om_tostring(), and RETURN.

Referenced by FlintDocument::do_get_data(), and FlintDocument::FlintDocument().

Xapian::doccount FlintRecordTable::get_doccount (  )  const

Get the number of records in the table.

Definition at line 50 of file flint_record.cc.

References CASSERT, CASSERT_TYPE_UNSIGNED, DEBUGCALL, FlintTable::get_entry_count(), and RETURN.

Referenced by FlintDatabase::get_avlength(), and FlintDatabase::get_doccount().

void FlintRecordTable::replace_record ( const string &  data,
Xapian::docid  did 
)

Definition at line 63 of file flint_record.cc.

References DEBUGCALL, and flint_docid_to_key().

Referenced by FlintWritableDatabase::add_document_(), and FlintWritableDatabase::replace_document().

void FlintRecordTable::delete_record ( Xapian::docid  did  ) 

Delete a record from the table.

Definition at line 70 of file flint_record.cc.

References DEBUGCALL, FlintTable::del(), flint_docid_to_key(), and om_tostring().

Referenced by FlintWritableDatabase::delete_document().


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.