xapian-core  1.4.19
Private Member Functions | Private Attributes | Friends | List of all members
GlassDocument Class Reference

A document read from a GlassDatabase. More...

#include <glass_document.h>

+ Inheritance diagram for GlassDocument:
+ Collaboration diagram for GlassDocument:

Public Member Functions

string do_get_value (Xapian::valueno slot) const
 Implementation of virtual methods. More...
 
void do_get_all_values (map< Xapian::valueno, string > &values_) const
 Retrieve all value values from the database. More...
 
string do_get_data () const
 Retrieve the document data from the database. More...
 
- Public Member Functions inherited from Xapian::Document::Internal
string get_value (Xapian::valueno slot) const
 Get value by value number. More...
 
void set_all_values (map< Xapian::valueno, string > &values_)
 Set all the values. More...
 
Xapian::valueno values_count () const
 
void add_value (Xapian::valueno, const string &)
 
void remove_value (Xapian::valueno)
 
void clear_values ()
 
void add_posting (const string &, Xapian::termpos, Xapian::termcount)
 
void add_term (const string &, Xapian::termcount)
 
void remove_posting (const string &, Xapian::termpos, Xapian::termcount)
 
Xapian::termpos remove_postings (const string &, Xapian::termpos, Xapian::termpos, Xapian::termcount)
 
void remove_term (const string &)
 
void clear_terms ()
 
Xapian::termcount termlist_count () const
 
string get_data () const
 Get data stored in document. More...
 
void set_data (const string &)
 
TermListopen_term_list () const
 Open a term list. More...
 
void need_values () const
 
void need_terms () const
 
bool data_modified () const
 Return true if the data in the document may have been modified. More...
 
bool values_modified () const
 Return true if the values in the document may have been modified. More...
 
bool terms_modified () const
 Return true if the terms in the document may have been modified. More...
 
bool term_positions_modified () const
 Return true if term positions may have been modified. More...
 
bool modified () const
 Return true if the document may have been modified. More...
 
Xapian::docid get_docid () const
 Get the docid which is associated with this document (if any). More...
 
string get_description () const
 Return a string describing this object. More...
 
 Internal (Xapian::Internal::intrusive_ptr< const Xapian::Database::Internal > database_, Xapian::docid did_)
 Constructor. More...
 
 Internal ()
 
virtual ~Internal ()
 Destructor. More...
 
- Public Member Functions inherited from Xapian::Internal::intrusive_base
 intrusive_base ()
 Construct with no references. More...
 

Private Member Functions

void operator= (const GlassDocument &)
 Don't allow assignment. More...
 
 GlassDocument (const GlassDocument &)
 Don't allow copying. More...
 
 GlassDocument (Xapian::Internal::intrusive_ptr< const Xapian::Database::Internal > db, Xapian::docid did_, const GlassValueManager *value_manager_, const GlassDocDataTable *docdata_table_)
 Private constructor - only called by GlassDatabase::open_document(). More...
 

Private Attributes

const GlassValueManagervalue_manager
 Used for lazy access to document values. More...
 
const GlassDocDataTabledocdata_table
 Used for lazy access to document data. More...
 

Friends

class GlassDatabase
 GlassDatabase::open_document() needs to call our private constructor. More...
 

Additional Inherited Members

- Public Types inherited from Xapian::Document::Internal
typedef map< Xapian::valueno, string > document_values
 Type to store values in. More...
 
typedef map< string, OmDocumentTermdocument_terms
 Type to store terms in. More...
 
- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Attributes inherited from Xapian::Document::Internal
Xapian::Internal::intrusive_ptr< const Xapian::Database::Internaldatabase
 The database this document is in. More...
 
Xapian::docid did
 The document ID of the document in that database. More...
 

Detailed Description

A document read from a GlassDatabase.

Definition at line 30 of file glass_document.h.

Constructor & Destructor Documentation

◆ GlassDocument() [1/2]

GlassDocument::GlassDocument ( const GlassDocument )
private

Don't allow copying.

◆ GlassDocument() [2/2]

GlassDocument::GlassDocument ( Xapian::Internal::intrusive_ptr< const Xapian::Database::Internal db,
Xapian::docid  did_,
const GlassValueManager value_manager_,
const GlassDocDataTable docdata_table_ 
)
inlineprivate

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

Definition at line 47 of file glass_document.h.

References do_get_all_values(), do_get_data(), and do_get_value().

Member Function Documentation

◆ do_get_all_values()

void GlassDocument::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 47 of file glass_document.cc.

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

Referenced by GlassDocument().

◆ do_get_data()

string GlassDocument::do_get_data ( ) const
virtual

Retrieve the document data from the database.

Reimplemented from Xapian::Document::Internal.

Definition at line 56 of file glass_document.cc.

References Xapian::Document::Internal::did, docdata_table, GlassDocDataTable::get_document_data(), LOGCALL, and RETURN.

Referenced by GlassDocument().

◆ do_get_value()

string GlassDocument::do_get_value ( Xapian::valueno  slot) const
virtual

Implementation of virtual methods.

Retrieve a value from the database.

Parameters
slotThe value number to retrieve.

Reimplemented from Xapian::Document::Internal.

Definition at line 38 of file glass_document.cc.

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

Referenced by GlassDocument().

◆ operator=()

void GlassDocument::operator= ( const GlassDocument )
private

Don't allow assignment.

Friends And Related Function Documentation

◆ GlassDatabase

friend class GlassDatabase
friend

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

Definition at line 44 of file glass_document.h.

Member Data Documentation

◆ docdata_table

const GlassDocDataTable* GlassDocument::docdata_table
private

Used for lazy access to document data.

Definition at line 41 of file glass_document.h.

Referenced by do_get_data().

◆ value_manager

const GlassValueManager* GlassDocument::value_manager
private

Used for lazy access to document values.

Definition at line 38 of file glass_document.h.

Referenced by do_get_all_values(), and do_get_value().


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