Xapian::ValueIterator Class Reference

An iterator pointing to values associated with a document. More...

#include <valueiterator.h>

Collaboration diagram for Xapian::ValueIterator:

[legend]List of all members.

Public Types
typedef std::input_iterator_tag	iterator_category
	Allow use as an STL iterator.
typedef std::string	value_type
typedef Xapian::valueno_diff	difference_type
typedef std::string *	pointer
typedef std::string &	reference
Public Member Functions
	ValueIterator ()
	Create an uninitialised iterator; this cannot be used, but is convenient syntactically.
	~ValueIterator ()
	ValueIterator (const ValueIterator &other)
	Copying is allowed (and is cheap).
void	operator= (const ValueIterator &other)
	Assignment is allowed (and is cheap).
ValueIterator &	operator++ ()
	Advance the iterator.
ValueIterator	operator++ (int)
	Advance the iterator (postfix variant).
const std::string &	operator * () const
	Get the value for the current position.
const std::string *	operator-> () const
	Get the value for the current position.
Xapian::valueno	get_valueno () const
	Get the number of the value at the current position.
std::string	get_description () const
	Return a string describing this object.
Private Member Functions
	ValueIterator (Xapian::valueno index_, const Document &doc_)
Private Attributes
Xapian::valueno	index
Document	doc
Friends
class	Document
bool	operator== (const ValueIterator &a, const ValueIterator &b)
bool	operator!= (const ValueIterator &a, const ValueIterator &b)

---

Detailed Description

An iterator pointing to values associated with a document.

Definition at line 37 of file valueiterator.h.

---

Member Typedef Documentation

typedef std::input_iterator_tag Xapian::ValueIterator::iterator_category

Allow use as an STL iterator.

Definition at line 96 of file valueiterator.h.

typedef std::string Xapian::ValueIterator::value_type

Definition at line 97 of file valueiterator.h.

typedef Xapian::valueno_diff Xapian::ValueIterator::difference_type

Definition at line 98 of file valueiterator.h.

typedef std::string* Xapian::ValueIterator::pointer

Definition at line 99 of file valueiterator.h.

typedef std::string& Xapian::ValueIterator::reference

Definition at line 100 of file valueiterator.h.

---

Constructor & Destructor Documentation

Xapian::ValueIterator::ValueIterator	(	Xapian::valueno	index_,
		const Document &	doc_
	)			[inline, private]

Definition at line 43 of file valueiterator.h.

Xapian::ValueIterator::ValueIterator

(

)

[inline]

Create an uninitialised iterator; this cannot be used, but is convenient syntactically.

Definition at line 53 of file valueiterator.h.

Xapian::ValueIterator::~ValueIterator

(

)

[inline]

Definition at line 55 of file valueiterator.h.

Xapian::ValueIterator::ValueIterator

(

const ValueIterator &

other

)

[inline]

Copying is allowed (and is cheap).

Definition at line 58 of file valueiterator.h.

References doc, and index.

---

Member Function Documentation

void Xapian::ValueIterator::operator=

(

const ValueIterator &

other

)

[inline]

Assignment is allowed (and is cheap).

Definition at line 64 of file valueiterator.h.

References doc, and index.

ValueIterator& Xapian::ValueIterator::operator++

(

)

[inline]

Advance the iterator.

Definition at line 70 of file valueiterator.h.

ValueIterator Xapian::ValueIterator::operator++

(

int

)

[inline]

Advance the iterator (postfix variant).

Definition at line 76 of file valueiterator.h.

const string & Xapian::ValueIterator::operator *

(

)

const

Get the value for the current position.

Definition at line 32 of file omvalueiterator.cc.

References Assert, DEBUGAPICALL, doc, index, Xapian::Document::internal, and RETURN.

const string * Xapian::ValueIterator::operator->

(

)

const

Get the value for the current position.

Definition at line 48 of file omvalueiterator.cc.

References Assert, DEBUGAPICALL, doc, index, Xapian::Document::internal, and RETURN.

Xapian::valueno Xapian::ValueIterator::get_valueno

(

)

const

Get the number of the value at the current position.

Definition at line 64 of file omvalueiterator.cc.

References Assert, DEBUGAPICALL, doc, index, Xapian::Document::internal, and RETURN.

Referenced by QuartzValueTable::encode_values(), FlintValueTable::encode_values(), InMemoryDatabase::finish_add_doc(), and show_values().

std::string Xapian::ValueIterator::get_description

(

)

const

Return a string describing this object.

Definition at line 80 of file omvalueiterator.cc.

References index, and om_tostring().

---

Friends And Related Function Documentation

friend class Document [friend]

Definition at line 39 of file valueiterator.h.

bool operator==	(	const ValueIterator &	a,
		const ValueIterator &	b
	)			[friend]

Definition at line 104 of file valueiterator.h.

bool operator!=	(	const ValueIterator &	a,
		const ValueIterator &	b
	)			[friend]

Definition at line 109 of file valueiterator.h.

---

Member Data Documentation

Xapian::valueno Xapian::ValueIterator::index [private]

Definition at line 46 of file valueiterator.h.

Referenced by get_description(), get_valueno(), operator *(), Xapian::operator!=(), operator->(), operator=(), Xapian::operator==(), and ValueIterator().

Document Xapian::ValueIterator::doc [private]

Definition at line 47 of file valueiterator.h.

Referenced by get_valueno(), operator *(), operator->(), operator=(), and ValueIterator().

---

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

• include/xapian/valueiterator.h
• api/omvalueiterator.cc

---