DocumentValueList Class Reference
Iteration over values in a document. More...
#include <documentvaluelist.h>
Public Member Functions | |
| DocumentValueList (const Xapian::Internal::RefCntPtr< Xapian::Document::Internal > &doc_) | |
| Xapian::docid | get_docid () const |
| Return the docid at the current position. | |
| std::string | get_value () const |
| Return the value at the current position. | |
| Xapian::valueno | get_valueno () const |
| Return the value slot for the current position/this iterator. | |
| bool | at_end () const |
| Return true if the current position is past the last entry in this list. | |
| void | next () |
| Advance the current position to the next document in the value stream. | |
| void | skip_to (Xapian::docid slot) |
| The parameter is actually a Xapian::valueno for this subclass. | |
| std::string | get_description () const |
| Return a string description of this object. | |
Private Member Functions | |
| void | operator= (const DocumentValueList &) |
| Don't allow assignment. | |
| DocumentValueList (const DocumentValueList &) | |
| Don't allow copying. | |
Private Attributes | |
| Xapian::Internal::RefCntPtr < const Xapian::Document::Internal > | doc |
| Document internals we're iterating over. | |
| Xapian::Document::Internal::document_values::const_iterator | it |
| Iterator over the map inside doc. | |
Detailed Description
Iteration over values in a document.Definition at line 29 of file documentvaluelist.h.
Constructor & Destructor Documentation
| DocumentValueList::DocumentValueList | ( | const DocumentValueList & | ) | [private] |
Don't allow copying.
| DocumentValueList::DocumentValueList | ( | const Xapian::Internal::RefCntPtr< Xapian::Document::Internal > & | doc_ | ) | [inline] |
Definition at line 46 of file documentvaluelist.h.
Member Function Documentation
| bool DocumentValueList::at_end | ( | ) | const [virtual] |
Return true if the current position is past the last entry in this list.
Implements Xapian::ValueIterator::Internal.
Definition at line 54 of file documentvaluelist.cc.
Referenced by get_description(), get_value(), and get_valueno().
| string DocumentValueList::get_description | ( | ) | const [virtual] |
Return a string description of this object.
Implements Xapian::ValueIterator::Internal.
Definition at line 76 of file documentvaluelist.cc.
References at_end(), get_value(), get_valueno(), and Xapian::Internal::str().
| Xapian::docid DocumentValueList::get_docid | ( | ) | const [virtual] |
Return the docid at the current position.
Implements Xapian::ValueIterator::Internal.
Definition at line 34 of file documentvaluelist.cc.
| string DocumentValueList::get_value | ( | ) | const [virtual] |
Return the value at the current position.
Implements Xapian::ValueIterator::Internal.
Definition at line 47 of file documentvaluelist.cc.
References Assert, at_end(), and it.
Referenced by get_description().
| Xapian::valueno DocumentValueList::get_valueno | ( | ) | const [virtual] |
Return the value slot for the current position/this iterator.
Implements Xapian::ValueIterator::Internal.
Definition at line 40 of file documentvaluelist.cc.
References Assert, at_end(), and it.
Referenced by get_description().
| void DocumentValueList::next | ( | ) | [virtual] |
Advance the current position to the next document in the value stream.
The list starts before the first entry in the list, so next() must be called before any methods which need the context of the current position.
Implements Xapian::ValueIterator::Internal.
Definition at line 60 of file documentvaluelist.cc.
| void DocumentValueList::operator= | ( | const DocumentValueList & | ) | [private] |
Don't allow assignment.
| void DocumentValueList::skip_to | ( | Xapian::docid | slot | ) | [virtual] |
The parameter is actually a Xapian::valueno for this subclass.
Implements Xapian::ValueIterator::Internal.
Definition at line 70 of file documentvaluelist.cc.
Member Data Documentation
Xapian::Internal::RefCntPtr<const Xapian::Document::Internal> DocumentValueList::doc [private] |
Xapian::Document::Internal::document_values::const_iterator DocumentValueList::it [private] |
Iterator over the map inside doc.
If we haven't started yet, this will be set to: doc->values.end()
Definition at line 43 of file documentvaluelist.h.
Referenced by at_end(), get_value(), get_valueno(), next(), and skip_to().
The documentation for this class was generated from the following files: