InMemoryAllDocsPostList Class Reference

A PostList over all docs in an inmemory database. More...

#include <inmemory_database.h>

Inheritance diagram for InMemoryAllDocsPostList:

Collaboration diagram for InMemoryAllDocsPostList:

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::termcount get_doclength () const

Return the length of current document.

Xapian::termcount get_wdf () const

Return the wdf for the document at the current position.

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.

Private Member Functions

InMemoryAllDocsPostList (Xapian::Internal::RefCntPtr< const InMemoryDatabase > db)

Private Attributes

Xapian::docid did

Xapian::Internal::RefCntPtr
< const InMemoryDatabase > db

Friends

class InMemoryDatabase

Detailed Description

A PostList over all docs in an inmemory database.

Definition at line 173 of file inmemory_database.h.

Constructor & Destructor Documentation

InMemoryAllDocsPostList::InMemoryAllDocsPostList ( Xapian::Internal::RefCntPtr< const InMemoryDatabase > db ) [private]

Definition at line 295 of file inmemory_database.cc.

Member Function Documentation

bool InMemoryAllDocsPostList::at_end ( ) const [virtual]

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

Implements Xapian::PostingIterator::Internal.

Definition at line 368 of file inmemory_database.cc.

References db, and did.

Referenced by next(), and skip_to().

string InMemoryAllDocsPostList::get_description ( ) const [virtual]

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 375 of file inmemory_database.cc.

References did, and Xapian::Internal::str().

Xapian::docid InMemoryAllDocsPostList::get_docid ( ) const [virtual]

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 308 of file inmemory_database.cc.

References Assert, db, and did.

Xapian::termcount InMemoryAllDocsPostList::get_doclength ( ) const [virtual]

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 318 of file inmemory_database.cc.

References db, and did.

Xapian::doccount InMemoryAllDocsPostList::get_termfreq ( ) const [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 301 of file inmemory_database.cc.

References db.

Xapian::termcount InMemoryAllDocsPostList::get_wdf ( ) const [virtual]

Return the wdf for the document at the current position.

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 325 of file inmemory_database.cc.

PostList * InMemoryAllDocsPostList::next ( Xapian::weight w_min ) [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 343 of file inmemory_database.cc.

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

PositionList * InMemoryAllDocsPostList::open_position_list ( ) const [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 337 of file inmemory_database.cc.

PositionList * InMemoryAllDocsPostList::read_position_list ( ) [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 331 of file inmemory_database.cc.

PostList * InMemoryAllDocsPostList::skip_to	(	Xapian::docid	,
		Xapian::weight	w_min
	)			`[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 354 of file inmemory_database.cc.

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

Friends And Related Function Documentation

friend class InMemoryDatabase [friend]

Definition at line 174 of file inmemory_database.h.

Member Data Documentation

Xapian::Internal::RefCntPtr<const InMemoryDatabase> InMemoryAllDocsPostList::db [private]

Definition at line 178 of file inmemory_database.h.

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

Xapian::docid InMemoryAllDocsPostList::did [private]

Definition at line 176 of file inmemory_database.h.

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

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

backends/inmemory/inmemory_database.h
backends/inmemory/inmemory_database.cc


Public Member Functions
Xapian::doccount	get_termfreq () const
	Return the exact term frequency.
Xapian::docid	get_docid () const
	Return the current docid.
Xapian::termcount	get_doclength () const
	Return the length of current document.
Xapian::termcount	get_wdf () const
	Return the wdf for the document at the current position.
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.
Private Member Functions
	InMemoryAllDocsPostList (Xapian::Internal::RefCntPtr< const InMemoryDatabase > db)
Private Attributes
Xapian::docid	did
Xapian::Internal::RefCntPtr < const InMemoryDatabase >	db
Friends
class	InMemoryDatabase