xapian-core  1.4.21
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ValueStreamDocument Class Reference

A document which gets its values from a ValueStreamManager. More...

#include <valuestreamdocument.h>

+ Inheritance diagram for ValueStreamDocument:
+ Collaboration diagram for ValueStreamDocument:

Public Member Functions

 ValueStreamDocument (const Xapian::Database &db_)
 
void new_subdb (int n)
 
 ~ValueStreamDocument ()
 
void set_document (Xapian::docid did_)
 
std::string get_value (Xapian::valueno slot) const
 
- 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 ValueStreamDocument &)
 Don't allow assignment. More...
 
 ValueStreamDocument (const ValueStreamDocument &)
 Don't allow copying. More...
 
std::string do_get_value (Xapian::valueno slot) const
 Implementation of virtual methods. More...
 
void do_get_all_values (std::map< Xapian::valueno, std::string > &values_) const
 Implementation of virtual methods. More...
 
std::string do_get_data () const
 Implementation of virtual methods. More...
 

Private Attributes

std::map< Xapian::valueno, ValueList * > valuelists
 
Xapian::Database db
 
size_t current
 
Xapian::Document::Internaldoc
 

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 which gets its values from a ValueStreamManager.

Definition at line 33 of file valuestreamdocument.h.

Constructor & Destructor Documentation

◆ ValueStreamDocument() [1/2]

ValueStreamDocument::ValueStreamDocument ( const ValueStreamDocument )
private

Don't allow copying.

◆ ValueStreamDocument() [2/2]

ValueStreamDocument::ValueStreamDocument ( const Xapian::Database db_)
inlineexplicit

Definition at line 49 of file valuestreamdocument.h.

References new_subdb(), and ~ValueStreamDocument().

◆ ~ValueStreamDocument()

ValueStreamDocument::~ValueStreamDocument ( )

Definition at line 38 of file valuestreamdocument.cc.

References clear_valuelists().

Referenced by ValueStreamDocument().

Member Function Documentation

◆ do_get_all_values()

void ValueStreamDocument::do_get_all_values ( std::map< Xapian::valueno, std::string > &  values_) const
privatevirtual

Implementation of virtual methods.

Reimplemented from Xapian::Document::Internal.

Definition at line 94 of file valuestreamdocument.cc.

Referenced by get_value().

◆ do_get_data()

string ValueStreamDocument::do_get_data ( ) const
privatevirtual

Implementation of virtual methods.

Reimplemented from Xapian::Document::Internal.

Definition at line 103 of file valuestreamdocument.cc.

Referenced by get_value().

◆ do_get_value()

string ValueStreamDocument::do_get_value ( Xapian::valueno  slot) const
privatevirtual

◆ get_value()

std::string ValueStreamDocument::get_value ( Xapian::valueno  slot) const
inline

Definition at line 66 of file valuestreamdocument.h.

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

◆ new_subdb()

void ValueStreamDocument::new_subdb ( int  n)

Definition at line 45 of file valuestreamdocument.cc.

References AssertRel, and clear_valuelists().

Referenced by MergePostList::next(), and ValueStreamDocument().

◆ operator=()

void ValueStreamDocument::operator= ( const ValueStreamDocument )
private

Don't allow assignment.

◆ set_document()

void ValueStreamDocument::set_document ( Xapian::docid  did_)
inline

Member Data Documentation

◆ current

size_t ValueStreamDocument::current
private

Definition at line 44 of file valuestreamdocument.h.

◆ db

Xapian::Database ValueStreamDocument::db
private

Definition at line 42 of file valuestreamdocument.h.

◆ doc

Xapian::Document::Internal* ValueStreamDocument::doc
mutableprivate

Definition at line 46 of file valuestreamdocument.h.

Referenced by set_document().

◆ valuelists

std::map<Xapian::valueno, ValueList *> ValueStreamDocument::valuelists
mutableprivate

Definition at line 40 of file valuestreamdocument.h.


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