QuartzTermList Class Reference

A termlist in a quartz database. More...

#include <quartz_termlist.h>

Inheritance diagram for QuartzTermList:

[legend]Collaboration diagram for QuartzTermList:


Public Member Functions
	QuartzTermList (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > this_db_, const Btree *table_, Xapian::docid did_, Xapian::doccount doccount_)
	Open the termlist for the specified document, for reading.
quartz_doclen_t	get_doclength () const
	Get the length of the document represented by the termlist.
Xapian::termcount	get_approx_size () const
	Return number of items in termlist.
TermList *	next ()
	Move to next entry.
bool	at_end () const
	Check whether the termlist reader has reached the end.
string	get_termname () const
	Get the current term in the termlist.
Xapian::termcount	get_wdf () const
	Get the within document frequency of the current term.
Xapian::doccount	get_termfreq () const
	Get the term frequency of the current term - the number of documents containing this term.
void	accumulate_stats (Xapian::Internal::ExpandStats &stats) const
	Collate weighting information for the current term.
Xapian::termcount	positionlist_count () const
Xapian::PositionIterator	positionlist_begin () const
Private Member Functions
	QuartzTermList (const QuartzTermList &)
QuartzTermList &	operator= (const QuartzTermList &)
Private Attributes
Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	this_db
	The database we are searching.
Xapian::docid	did
const Btree *	table
	The table holding the termlist.
string	termlist_part
	The data for the (part of the) termlist currently being read.
const char *	pos
	Position within tag that we're reading from.
const char *	end
	End of data within tag.
bool	have_finished
	Whether we have moved past the final item yet.
quartz_doclen_t	doclen
	The length of the document represented by the termlist.
Xapian::termcount	termlist_size
	The size of the termlist.
string	current_tname
	Current termname.
Xapian::termcount	current_wdf
	Current wdf.
bool	has_termfreqs
	Whether the termlist stores term frequencies (this cannot be done in an updatable database, but improves expand efficiency considerably).
Xapian::doccount	current_termfreq
	Current term frequency.
Xapian::doccount	doccount
	Number of documents in database.

Detailed Description

A termlist in a quartz database.

Definition at line 76 of file quartz_termlist.h.

Constructor & Destructor Documentation

QuartzTermList::QuartzTermList ( const QuartzTermList & ) [private]

QuartzTermList::QuartzTermList	(	Xapian::Internal::RefCntPtr< const Xapian::Database::Internal >	this_db_,
		const Btree *	table_,
		Xapian::docid	did_,
		Xapian::doccount	doccount_
	)

Open the termlist for the specified document, for reading.

Definition at line 94 of file quartz_termlist.cc.

References Assert, DEBUGCALL, DEBUGLINE, did, doclen, end, Btree::get_exact_entry(), has_termfreqs, om_tostring(), pos, quartz_docid_to_key(), table, termlist_part, termlist_size, unpack_bool(), and unpack_uint().

Member Function Documentation

QuartzTermList& QuartzTermList::operator= ( const QuartzTermList & ) [private]

quartz_doclen_t QuartzTermList::get_doclength ( ) const

Get the length of the document represented by the termlist.

FIXME: having a static version of this available would be nice - database could then avoid having to create a temporary termlist object.

Definition at line 143 of file quartz_termlist.cc.

References DEBUGCALL, doclen, and RETURN.

Referenced by QuartzWritableDatabase::delete_document(), QuartzDatabase::get_doclength(), and QuartzWritableDatabase::replace_document().

Xapian::termcount QuartzTermList::get_approx_size ( ) const

Return number of items in termlist.

(This is actually exact - it may be approximate for combined termlists.)

Definition at line 136 of file quartz_termlist.cc.

References DEBUGCALL, RETURN, and termlist_size.

TermList * QuartzTermList::next ( )

Move to next entry.

Must be called before any of the other methods, including at_end(), to move onto the first entry.

Returns:: This method always returns 0. Other values would represent a termlist which should be used to replace this termlist - this never happens.

Definition at line 151 of file quartz_termlist.cc.

References current_termfreq, current_tname, current_wdf, DEBUGCALL, DEBUGLINE, end, has_termfreqs, have_finished, pos, RETURN, and unpack_uint().

Referenced by QuartzWritableDatabase::delete_document(), and QuartzWritableDatabase::replace_document().

bool QuartzTermList::at_end ( ) const

Check whether the termlist reader has reached the end.

Definition at line 202 of file quartz_termlist.cc.

References DEBUGCALL, have_finished, and RETURN.

Referenced by QuartzWritableDatabase::delete_document(), and QuartzWritableDatabase::replace_document().

string QuartzTermList::get_termname ( ) const

Get the current term in the termlist.

Definition at line 209 of file quartz_termlist.cc.

References current_tname, DEBUGCALL, and RETURN.