ValueStreamDocument Class Reference

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

#include <valuestreamdocument.h>

Inheritance diagram for ValueStreamDocument:

Inheritance graph
[legend]
Collaboration diagram for ValueStreamDocument:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ValueStreamDocument (const Xapian::Database &db_)
void new_subdb (int n)
 ~ValueStreamDocument ()
void set_document (Xapian::docid did_)
string get_value (Xapian::valueno slot) const
 Get value by value number.

Private Member Functions

void operator= (const ValueStreamDocument &)
 Don't allow assignment.
 ValueStreamDocument (const ValueStreamDocument &)
 Don't allow copying.
string do_get_value (Xapian::valueno slot) const
 Implementation of virtual methods.
void do_get_all_values (map< Xapian::valueno, string > &values_) const
 Implementation of virtual methods.
string do_get_data () const
 Implementation of virtual methods.

Private Attributes

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


Detailed Description

A document which gets its values from a ValueStreamManager.

Definition at line 31 of file valuestreamdocument.h.


Constructor & Destructor Documentation

ValueStreamDocument::ValueStreamDocument ( const ValueStreamDocument  )  [private]

Don't allow copying.

ValueStreamDocument::ValueStreamDocument ( const Xapian::Database db_  )  [inline]

Definition at line 47 of file valuestreamdocument.h.

ValueStreamDocument::~ValueStreamDocument (  ) 

Definition at line 38 of file valuestreamdocument.cc.

References clear_valuelists(), doc, and valuelists.


Member Function Documentation

void ValueStreamDocument::do_get_all_values ( map< Xapian::valueno, string > &  values_  )  const [private]

Implementation of virtual methods.

string ValueStreamDocument::do_get_data (  )  const [private, virtual]

Implementation of virtual methods.

Reimplemented from Xapian::Document::Internal.

Definition at line 104 of file valuestreamdocument.cc.

References db, Xapian::Document::Internal::did, Xapian::Document::Internal::do_get_data(), doc, and Xapian::Database::get_document_lazily().

string ValueStreamDocument::do_get_value ( Xapian::valueno  slot  )  const [private, virtual]

string ValueStreamDocument::get_value ( Xapian::valueno  slot  )  const [inline]

Get value by value number.

Values are quickly accessible fields, for use during the match operation. Each document may have a set of values, each of which having a different value number. Duplicate values with the same value number are not supported in a single document.

Value numbers are any integer >= 0, but particular database backends may impose a more restrictive range than that.

Parameters:
slot The value number requested.
Returns:
A string containing the specified value. If the value is not present in this document, the value's value will be a zero length string

Reimplemented from Xapian::Document::Internal.

Definition at line 61 of file valuestreamdocument.h.

References do_get_value().

void ValueStreamDocument::new_subdb ( int  n  ) 

void ValueStreamDocument::operator= ( const ValueStreamDocument  )  [private]

Don't allow assignment.

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

Definition at line 54 of file valuestreamdocument.h.

References Xapian::Document::Internal::did, and doc.


Member Data Documentation

size_t ValueStreamDocument::current [private]

Definition at line 42 of file valuestreamdocument.h.

Referenced by do_get_value(), and new_subdb().

Definition at line 40 of file valuestreamdocument.h.

Referenced by do_get_data(), do_get_value(), and new_subdb().

Definition at line 38 of file valuestreamdocument.h.

Referenced by do_get_value(), new_subdb(), and ~ValueStreamDocument().


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

Documentation for Xapian (version 1.2.13).
Generated on 9 Jan 2013 by Doxygen 1.5.9.