QuartzAllDocsPostList Class Reference

A postlist in a quartz database. More...

#include <quartz_alldocspostlist.h>

Inheritance diagram for QuartzAllDocsPostList:

[legend]Collaboration diagram for QuartzAllDocsPostList:

[legend]List of all members.

Public Member Functions
	QuartzAllDocsPostList (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > this_db_, const Btree *table, Xapian::doccount doccount_)
	Default constructor.
	~QuartzAllDocsPostList ()
	Destructor.
Xapian::doccount	get_termfreq () const
	Returns length of the all documents postlist.
Xapian::docid	get_docid () const
	Returns the current docid.
Xapian::doclength	get_doclength () const
	Returns the length of current document.
Xapian::termcount	get_wdf () const
	Returns the Within Document Frequency of the term in the current document.
PositionList *	read_position_list ()
	Get the list of positions of the term in the current document.
PositionList *	open_position_list () const
	Get the list of positions of the term in the current document.
PostList *	next (Xapian::weight w_min)
	Move to the next document.
PostList *	skip_to (Xapian::docid desired_did, Xapian::weight w_min)
	Skip to next document with docid >= docid.
bool	at_end () const
	Return true if and only if we're off the end of the list.
std::string	get_description () const
	Get a description of the postlist.
Private Member Functions
	QuartzAllDocsPostList (const QuartzAllDocsPostList &)
	Copying is not allowed.
void	operator= (const QuartzAllDocsPostList &)
	Assignment is not allowed.
Private Attributes
Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	this_db
	Pointer to database.
QuartzDocIdList	docids
	List of docids.
QuartzDocIdListIterator	dociditer
	Iterator through docids.
Xapian::doccount	doccount
	Number of documents in the database.
bool	have_started
	Whether we've started yet.

---

Detailed Description

A postlist in a quartz database.

Definition at line 123 of file quartz_alldocspostlist.h.

---

Constructor & Destructor Documentation

QuartzAllDocsPostList::QuartzAllDocsPostList

(

const QuartzAllDocsPostList &

)

[private]

Copying is not allowed.

QuartzAllDocsPostList::QuartzAllDocsPostList	(	Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	this_db_,
		const Btree *	table,
		Xapian::doccount	doccount_
	)

Default constructor.

Definition at line 176 of file quartz_alldocspostlist.cc.

References QuartzDocIdList::addDocId(), Btree::cursor_get(), DEBUGCALL, docids, Xapian::Internal::RefCntPtr< T >::get(), and unpack_uint_last().

QuartzAllDocsPostList::~QuartzAllDocsPostList

(

)

Destructor.

Definition at line 205 of file quartz_alldocspostlist.cc.

References DEBUGCALL.

---

Member Function Documentation

void QuartzAllDocsPostList::operator=

(

const QuartzAllDocsPostList &

)

[private]

Assignment is not allowed.

Xapian::doccount QuartzAllDocsPostList::get_termfreq

(

)

const [inline, virtual]

Returns length of the all documents postlist.

This is also the number of documents in the database.

Implements LeafPostList.

Definition at line 159 of file quartz_alldocspostlist.h.

References doccount.

Xapian::docid QuartzAllDocsPostList::get_docid

(

)

const [inline, virtual]

Returns the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 162 of file quartz_alldocspostlist.h.

References Assert, dociditer, and have_started.

Xapian::doclength QuartzAllDocsPostList::get_doclength

(

)

const [inline, virtual]

Returns the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 168 of file quartz_alldocspostlist.h.

References Assert, dociditer, have_started, and this_db.

Xapian::termcount QuartzAllDocsPostList::get_wdf

(

)

const [inline, virtual]

Returns the Within Document Frequency of the term in the current document.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 176 of file quartz_alldocspostlist.h.

References Assert, and have_started.

PositionList* QuartzAllDocsPostList::read_position_list

(

)

[inline, virtual]

Get the list of positions of the term in the current document.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 183 of file quartz_alldocspostlist.h.

PositionList* QuartzAllDocsPostList::open_position_list

(

)

const [inline, virtual]

Get the list of positions of the term in the current document.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 189 of file quartz_alldocspostlist.h.

PostList * QuartzAllDocsPostList::next

(

Xapian::weight

w_min

)

[virtual]

Move to the next document.

Implements Xapian::PostingIterator::Internal.

Definition at line 211 of file quartz_alldocspostlist.cc.

References QuartzDocIdList::begin(), DEBUGCALL, DEBUGLINE, dociditer, docids, QuartzDocIdList::end(), have_started, om_tostring(), and RETURN.

PostList * QuartzAllDocsPostList::skip_to	(	Xapian::docid	desired_did,
		Xapian::weight	w_min
	)			[virtual]

Skip to next document with docid >= docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 231 of file quartz_alldocspostlist.cc.

References QuartzDocIdList::begin(), DEBUGCALL, DEBUGLINE, dociditer, docids, QuartzDocIdList::end(), have_started, om_tostring(), and RETURN.

bool QuartzAllDocsPostList::at_end

(

)

const [inline, virtual]

Return true if and only if we're off the end of the list.

Implements Xapian::PostingIterator::Internal.

Definition at line 200 of file quartz_alldocspostlist.h.

References dociditer, docids, QuartzDocIdList::end(), and have_started.

string QuartzAllDocsPostList::get_description

(

)

const [virtual]

Get a description of the postlist.

Implements Xapian::PostingIterator::Internal.

Definition at line 257 of file quartz_alldocspostlist.cc.

References doccount, and om_tostring().

---

Member Data Documentation

Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> QuartzAllDocsPostList::this_db [private]

Pointer to database.

Definition at line 126 of file quartz_alldocspostlist.h.

Referenced by get_doclength().

QuartzDocIdList QuartzAllDocsPostList::docids [private]

List of docids.

Definition at line 129 of file quartz_alldocspostlist.h.

Referenced by at_end(), next(), QuartzAllDocsPostList(), and skip_to().

QuartzDocIdListIterator QuartzAllDocsPostList::dociditer [private]

Iterator through docids.

Definition at line 132 of file quartz_alldocspostlist.h.

Referenced by at_end(), get_docid(), get_doclength(), next(), and skip_to().

Xapian::doccount QuartzAllDocsPostList::doccount [private]

Number of documents in the database.

Definition at line 135 of file quartz_alldocspostlist.h.

Referenced by get_description(), and get_termfreq().

bool QuartzAllDocsPostList::have_started [private]

Whether we've started yet.

Definition at line 138 of file quartz_alldocspostlist.h.

Referenced by at_end(), get_docid(), get_doclength(), get_wdf(), next(), and skip_to().

---

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

• backends/quartz/quartz_alldocspostlist.h
• backends/quartz/quartz_alldocspostlist.cc

---