DocIDKeyedCursor Class Reference

Inheritance diagram for DocIDKeyedCursor:

Inheritance graph
[legend]
Collaboration diagram for DocIDKeyedCursor:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DocIDKeyedCursor (Btree *in, Xapian::docid offset_)
bool next ()
 Advance to the next key.

Public Attributes

string key
string tag

Private Attributes

Xapian::docid offset

Detailed Description

Definition at line 125 of file quartzcompact.cc.


Constructor & Destructor Documentation

DocIDKeyedCursor::DocIDKeyedCursor ( Btree in,
Xapian::docid  offset_ 
) [inline]

Definition at line 130 of file quartzcompact.cc.

References Bcursor::find_entry(), and next().


Member Function Documentation

bool DocIDKeyedCursor::next (  )  [inline]

Advance to the next key.

If cursor is unpositioned, the result is simply false.

If cursor is positioned, and points to the very last item in the Btree the cursor is made unpositioned, and the result is false. Otherwise the cursor is moved to the next item in the B-tree, and the result is true.

Effectively, Bcursor::next() loses the position of BC when it drops off the end of the list of items. If this is awkward, one can always arrange for a key to be present which has a rightmost position in a set of keys,

Reimplemented from Bcursor.

Definition at line 137 of file quartzcompact.cc.

References Bcursor::current_key, Bcursor::current_tag, is_metainfo_key(), key, Bcursor::next(), offset, pack_uint_last(), Bcursor::read_tag(), tag, and unpack_uint_last().

Referenced by DocIDKeyedCursor().


Member Data Documentation

Xapian::docid DocIDKeyedCursor::offset [private]

Definition at line 126 of file quartzcompact.cc.

Referenced by next().

string DocIDKeyedCursor::key

Definition at line 128 of file quartzcompact.cc.

Referenced by next(), and CursorGt::operator()().

string DocIDKeyedCursor::tag

Definition at line 128 of file quartzcompact.cc.

Referenced by next().


The documentation for this class was generated from the following file:
Documentation for Xapian (version 1.0.10).
Generated on 24 Dec 2008 by Doxygen 1.5.2.