EmptyPostList Class Reference

#include <emptypostlist.h>

Inheritance diagram for EmptyPostList:

[legend]Collaboration diagram for EmptyPostList:

[legend]List of all members.

Public Member Functions
Xapian::doccount	get_termfreq () const
	Return the exact term frequency.
Xapian::docid	get_docid () const
	Return the current docid.
Xapian::weight	get_weight () const
	Return the weight contribution for the current position.
Xapian::weight	get_maxweight () const
	Return an upper bound on what get_weight() can return.
Xapian::doclength	get_doclength () const
	Return the length of current document.
PositionList *	read_position_list ()
	Read the position list for the term in the current document and return a pointer to it (owned by the PostList).
PositionList *	open_position_list () const
	Read the position list for the term in the current document and return a pointer to it (not owned by the PostList).
PostList *	next (Xapian::weight w_min)
	Advance the current position to the next document in the postlist.
PostList *	skip_to (Xapian::docid did, Xapian::weight w_min)
	Skip forward to the specified docid.
bool	at_end () const
	Return true if the current position is past the last entry in this list.
string	get_description () const
	Return a string description of this object.

---

Detailed Description

Definition at line 28 of file emptypostlist.h.

---

Member Function Documentation

Xapian::doccount EmptyPostList::get_termfreq

(

)

const [inline, virtual]

Return the exact term frequency.

Leaf postlists have an exact termfreq, which get_termfreq_min(), get_termfreq_max(), and get_termfreq_est() all report.

Implements LeafPostList.

Definition at line 30 of file emptypostlist.h.

Xapian::docid EmptyPostList::get_docid

(

)

const [inline, virtual]

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 47 of file emptypostlist.h.

References Assert.

Xapian::weight EmptyPostList::get_weight

(

)

const [inline, virtual]

Return the weight contribution for the current position.

Reimplemented from LeafPostList.

Definition at line 54 of file emptypostlist.h.

References Assert.

Xapian::weight EmptyPostList::get_maxweight

(

)

const [inline, virtual]

Return an upper bound on what get_weight() can return.

Reimplemented from LeafPostList.

Definition at line 34 of file emptypostlist.h.

Xapian::doclength EmptyPostList::get_doclength

(

)

const [inline, virtual]

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 61 of file emptypostlist.h.

References Assert.

PositionList * EmptyPostList::read_position_list

(

)

[inline, virtual]

Read the position list for the term in the current document and return a pointer to it (owned by the PostList).

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 68 of file emptypostlist.h.

References Assert.

PositionList * EmptyPostList::open_position_list

(

)

const [inline, virtual]

Read the position list for the term in the current document and return a pointer to it (not owned by the PostList).

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 75 of file emptypostlist.h.

References Assert.

PostList * EmptyPostList::next

(

Xapian::weight

w_min

)

[inline, virtual]

Advance the current position to the next document in the postlist.

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.

Parameters:

w_min

The minimum weight contribution that is needed (this is just a hint which PostList subclasses may ignore).

Returns:

If a non-NULL pointer is returned, then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.

Implements Xapian::PostingIterator::Internal.

Definition at line 82 of file emptypostlist.h.

PostList * EmptyPostList::skip_to	(	Xapian::docid	,
		Xapian::weight	w_min
	)			[inline, virtual]

Skip forward to the specified docid.

If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present).

Parameters:

w_min

The minimum weight contribution that is needed (this is just a hint which PostList subclasses may ignore).

Returns:

If a non-NULL pointer is returned, then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.

Implements Xapian::PostingIterator::Internal.

Definition at line 88 of file emptypostlist.h.

bool EmptyPostList::at_end

(

)

const [inline, virtual]

Return true if the current position is past the last entry in this list.

Implements Xapian::PostingIterator::Internal.

Definition at line 94 of file emptypostlist.h.

string EmptyPostList::get_description

(

)

const [inline, virtual]

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 100 of file emptypostlist.h.

---

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

• common/emptypostlist.h

---