FlintModifiedPostList Class Reference

#include <flint_modifiedpostlist.h>

Inheritance diagram for FlintModifiedPostList:

[legend]Collaboration diagram for FlintModifiedPostList:

[legend]List of all members.

Public Member Functions
	FlintModifiedPostList (Xapian::Internal::RefCntPtr< const FlintDatabase > this_db_, const string &tname_, const map< Xapian::docid, pair< char, Xapian::termcount > > &mods_)
	Constructor.
	~FlintModifiedPostList ()
Xapian::doccount	get_termfreq () const
	Returns number of docs indexed by this term.
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 document.
Private Member Functions
void	skip_deletes (Xapian::weight w_min)
	Skip over deleted documents after a next() or skip_to().
Private Attributes
PositionList *	poslist
	Pointer to PositionList returned from read_position_list to be deleted.
map< Xapian::docid, pair< char, Xapian::termcount > >	mods
	Modifications to apply to the FlintPostList.
map< Xapian::docid, pair< char, Xapian::termcount > >::const_iterator	it

---

Detailed Description

Definition at line 31 of file flint_modifiedpostlist.h.

---

Constructor & Destructor Documentation

FlintModifiedPostList::FlintModifiedPostList	(	Xapian::Internal::RefCntPtr< const FlintDatabase >	this_db_,
		const string &	tname_,
		const map< Xapian::docid, pair< char, Xapian::termcount > > &	mods_
	)			[inline]

Constructor.

Definition at line 46 of file flint_modifiedpostlist.h.

FlintModifiedPostList::~FlintModifiedPostList

(

)

Definition at line 26 of file flint_modifiedpostlist.cc.

References poslist.

---

Member Function Documentation

void FlintModifiedPostList::skip_deletes

(

Xapian::weight

w_min

)

[private]

Skip over deleted documents after a next() or skip_to().

Definition at line 32 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), FlintPostList::get_docid(), it, mods, and Xapian::PostingIterator::Internal::next().

Referenced by next(), and skip_to().

Xapian::doccount FlintModifiedPostList::get_termfreq

(

)

const [virtual]

Returns number of docs indexed by this term.

This is the length of the postlist.

Reimplemented from FlintPostList.

Definition at line 45 of file flint_modifiedpostlist.cc.

References FlintPostList::this_db, and FlintPostList::tname.

Xapian::docid FlintModifiedPostList::get_docid

(

)

const [virtual]

Returns the current docid.

Reimplemented from FlintPostList.

Definition at line 51 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), FlintPostList::get_docid(), it, and mods.

Xapian::doclength FlintModifiedPostList::get_doclength

(

)

const [virtual]

Returns the length of current document.

Reimplemented from FlintPostList.

Definition at line 59 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), DEBUGCALL, FlintPostList::get_docid(), FlintPostList::get_doclength(), it, mods, RETURN, and FlintPostList::this_db.

Xapian::termcount FlintModifiedPostList::get_wdf

(

)

const [virtual]

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

Reimplemented from FlintPostList.

Definition at line 68 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), FlintPostList::get_docid(), FlintPostList::get_wdf(), it, and mods.

PositionList * FlintModifiedPostList::read_position_list

(

)

[virtual]

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

Reimplemented from FlintPostList.

Definition at line 80 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), FlintPostList::get_docid(), it, mods, poslist, FlintPostList::read_position_list(), FlintPostList::this_db, and FlintPostList::tname.

PositionList * FlintModifiedPostList::open_position_list

(

)

const [virtual]

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

Reimplemented from FlintPostList.

Definition at line 94 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), FlintPostList::get_docid(), it, mods, FlintPostList::open_position_list(), FlintPostList::this_db, and FlintPostList::tname.

PostList * FlintModifiedPostList::next

(

Xapian::weight

w_min

)

[virtual]

Move to the next document.

Reimplemented from FlintPostList.

Definition at line 103 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), FlintPostList::get_docid(), FlintPostList::have_started, it, mods, Xapian::PostingIterator::Internal::next(), and skip_deletes().

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

Skip to next document with docid >= docid.

Reimplemented from FlintPostList.

Definition at line 127 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), it, mods, skip_deletes(), and FlintPostList::skip_to().

bool FlintModifiedPostList::at_end

(

)

const [virtual]

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

Reimplemented from FlintPostList.

Definition at line 137 of file flint_modifiedpostlist.cc.

References FlintPostList::at_end(), it, and mods.

std::string FlintModifiedPostList::get_description

(

)

const [virtual]

Get a description of the document.

Reimplemented from FlintPostList.

Definition at line 142 of file flint_modifiedpostlist.cc.

References FlintPostList::get_description().

---

Member Data Documentation

map<Xapian::docid, pair<char, Xapian::termcount> > FlintModifiedPostList::mods [private]

Modifications to apply to the FlintPostList.

Definition at line 34 of file flint_modifiedpostlist.h.

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

map<Xapian::docid, pair<char, Xapian::termcount> >::const_iterator FlintModifiedPostList::it [private]

Definition at line 35 of file flint_modifiedpostlist.h.

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

PositionList* FlintModifiedPostList::poslist [private]

Pointer to PositionList returned from read_position_list to be deleted.

Definition at line 39 of file flint_modifiedpostlist.h.

Referenced by read_position_list(), and ~FlintModifiedPostList().

---

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

• backends/flint/flint_modifiedpostlist.h
• backends/flint/flint_modifiedpostlist.cc

---