ContiguousAllDocsPostList Class Reference

A PostList iteratating all docids when they form a contiguous range. More...

#include <contiguousalldocspostlist.h>

Inheritance diagram for ContiguousAllDocsPostList:

[legend]Collaboration diagram for ContiguousAllDocsPostList:

[legend]List of all members.

Public Member Functions
	ContiguousAllDocsPostList (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > db_, Xapian::doccount doccount_)
	Constructor.
	~ContiguousAllDocsPostList ()
	Destructor.
Xapian::doccount	get_termfreq () const
	Return the term frequency.
Xapian::docid	get_docid () const
	Return the current docid.
Xapian::doclength	get_doclength () const
	Return the length of current document.
Xapian::termcount	get_wdf () const
	Always return 1 (wdf isn't totally meaningful for us).
PositionList *	read_position_list ()
	Throws InvalidOperationError.
PositionList *	open_position_list () const
	Throws InvalidOperationError.
PostList *	next (Xapian::weight w_min)
	Advance to the next document.
PostList *	skip_to (Xapian::docid target, Xapian::weight w_min)
	Skip ahead to next document with docid >= target.
bool	at_end () const
	Return true if and only if we're off the end of the list.
std::string	get_description () const
	Return a string description of this object.
Private Member Functions
void	operator= (const ContiguousAllDocsPostList &)
	Don't allow assignment.
	ContiguousAllDocsPostList (const ContiguousAllDocsPostList &)
	Don't allow copying.
Private Attributes
Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	db
	The database we're iterating over.
Xapian::docid	did
	The current document id.
Xapian::doccount	doccount
	The number of documents in the database.

---

Detailed Description

A PostList iteratating all docids when they form a contiguous range.

Definition at line 30 of file contiguousalldocspostlist.h.

---

Constructor & Destructor Documentation

ContiguousAllDocsPostList::ContiguousAllDocsPostList

(

const ContiguousAllDocsPostList &

)

[private]

Don't allow copying.

ContiguousAllDocsPostList::ContiguousAllDocsPostList	(	Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	db_,
		Xapian::doccount	doccount_
	)			[inline]

Constructor.

Definition at line 48 of file contiguousalldocspostlist.h.

ContiguousAllDocsPostList::~ContiguousAllDocsPostList

(

)

Destructor.

Definition at line 32 of file contiguousalldocspostlist.cc.

---

Member Function Documentation

void ContiguousAllDocsPostList::operator=

(

const ContiguousAllDocsPostList &

)

[private]

Don't allow assignment.

Xapian::doccount ContiguousAllDocsPostList::get_termfreq

(

)

const [virtual]

Return the term frequency.

For an all documents postlist, this is the number of documents in the database.

Implements LeafPostList.

Definition at line 35 of file contiguousalldocspostlist.cc.

References doccount.

Xapian::docid ContiguousAllDocsPostList::get_docid

(

)

const [virtual]

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 41 of file contiguousalldocspostlist.cc.

References Assert, at_end(), and did.

Xapian::doclength ContiguousAllDocsPostList::get_doclength

(

)

const [virtual]

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 49 of file contiguousalldocspostlist.cc.

References Assert, at_end(), db, and did.

Xapian::termcount ContiguousAllDocsPostList::get_wdf

(

)

const [virtual]

Always return 1 (wdf isn't totally meaningful for us).

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 57 of file contiguousalldocspostlist.cc.

References Assert, at_end(), and did.

PositionList * ContiguousAllDocsPostList::read_position_list

(

)

[virtual]

Throws InvalidOperationError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 65 of file contiguousalldocspostlist.cc.

References open_position_list().

PositionList * ContiguousAllDocsPostList::open_position_list

(

)

const [virtual]

Throws InvalidOperationError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 72 of file contiguousalldocspostlist.cc.

Referenced by read_position_list().

PostList * ContiguousAllDocsPostList::next

(

Xapian::weight

w_min

)

[virtual]

Advance to the next document.

Implements Xapian::PostingIterator::Internal.

Definition at line 78 of file contiguousalldocspostlist.cc.

References Assert, at_end(), db, did, and doccount.

PostList * ContiguousAllDocsPostList::skip_to	(	Xapian::docid	target,
		Xapian::weight	w_min
	)			[virtual]

Skip ahead to next document with docid >= target.

Implements Xapian::PostingIterator::Internal.

Definition at line 90 of file contiguousalldocspostlist.cc.

References Assert, at_end(), db, did, and doccount.

bool ContiguousAllDocsPostList::at_end

(

)

const [virtual]

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

Implements Xapian::PostingIterator::Internal.

Definition at line 104 of file contiguousalldocspostlist.cc.

References db, and Xapian::Internal::RefCntPtr< T >::get().

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

string ContiguousAllDocsPostList::get_description

(

)

const [virtual]

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 110 of file contiguousalldocspostlist.cc.

References doccount, and om_tostring().

---

Member Data Documentation

Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> ContiguousAllDocsPostList::db [private]

The database we're iterating over.

Definition at line 38 of file contiguousalldocspostlist.h.

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

Xapian::docid ContiguousAllDocsPostList::did [private]

The current document id.

Definition at line 41 of file contiguousalldocspostlist.h.

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

Xapian::doccount ContiguousAllDocsPostList::doccount [private]

The number of documents in the database.

Definition at line 44 of file contiguousalldocspostlist.h.

Referenced by get_description(), get_termfreq(), next(), and skip_to().

---

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

• backends/flint/contiguousalldocspostlist.h
• backends/flint/contiguousalldocspostlist.cc

---