A TermList in a glass database. More...

#include <glass_termlist.h>

Inheritance diagram for GlassTermList:

Collaboration diagram for GlassTermList:

Public Member Functions
	GlassTermList (Xapian::Internal::intrusive_ptr< const GlassDatabase > db_, Xapian::docid did_, bool throw_if_not_present=true)
	Create a new GlassTermList object for document did_ in DB db_. More...

Xapian::termcount	get_doclength () const
	Return the length of this document. More...

Xapian::termcount	get_unique_terms () const
	Return the number of unique terms. More...

Xapian::termcount	get_approx_size () const
	Return approximate size of this termlist. More...

void	accumulate_stats (Xapian::Internal::ExpandStats &stats) const
	Collate weighting information for the current term. More...

std::string	get_termname () const
	Return the termname at the current position. More...

Xapian::termcount	get_wdf () const
	Return the wdf for the term at the current position. More...

Xapian::doccount	get_termfreq () const
	Return the term frequency for the term at the current position. More...

TermList *	next ()
	Advance the current position to the next term in the termlist. More...

TermList *	skip_to (const std::string &term)
	Skip forward to the specified term. More...

bool	at_end () const
	Return true if the current position is past the last term in this list. More...

Xapian::termcount	positionlist_count () const
	Return the length of the position list for the current position. More...

Xapian::PositionIterator	positionlist_begin () const
	Return a PositionIterator for the current position. More...

Public Member Functions inherited from Xapian::TermIterator::Internal
virtual	~Internal ()
	We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor. More...

virtual const std::vector< Xapian::termpos > *	get_vector_termpos () const
	Get pointer to vector<termpos> if that's the internal representation. More...

Public Member Functions inherited from Xapian::Internal::intrusive_base
	intrusive_base ()
	Construct with no references. More...

Private Member Functions
void	operator= (const GlassTermList &)
	Don't allow assignment. More...

	GlassTermList (const GlassTermList &)
	Don't allow copying. More...

Private Attributes
Xapian::Internal::intrusive_ptr< const GlassDatabase >	db
	The database we're reading data from. More...

Xapian::docid	did
	The document id that this TermList is for. More...

Xapian::termcount	doclen
	The length of document did. More...

Xapian::termcount	termlist_size
	The number of entries in this termlist. More...

std::string	data
	The tag value from the termlist table which holds the encoded termlist. More...

const char *	pos
	Current position with the encoded tag value held in data. More...

const char *	end
	Pointer to the end of the encoded tag value. More...

std::string	current_term
	The termname at the current position. More...

Xapian::termcount	current_wdf
	The wdf for the term at the current position. More...

Xapian::doccount	current_termfreq
	The term frequency for the term at the current position. More...

Additional Inherited Members
Public Attributes inherited from Xapian::TermIterator::Internal
size_t	shard_index = 0
	Which shard of a multidatabase this is from. More...

Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned	_refs
	Reference count. More...

Protected Member Functions inherited from Xapian::TermIterator::Internal
	Internal ()
	Only constructable as a base class for derived classes. More...

Detailed Description

A TermList in a glass database.

Definition at line 41 of file glass_termlist.h.

Constructor & Destructor Documentation

◆ GlassTermList() [1/2]

GlassTermList::GlassTermList ( const GlassTermList & )

private

Don't allow copying.

◆ GlassTermList() [2/2]

GlassTermList::GlassTermList	(	Xapian::Internal::intrusive_ptr< const GlassDatabase >	db_,
		Xapian::docid	did_,
		bool	throw_if_not_present = `true`
	)

Create a new GlassTermList object for document did_ in DB db_.

Parameters

throw_if_not_present Specifies behaviour if document did_ isn't present: if true then throw DocNotFoundError, otherwise the constructed GlassTermList object will signal at_end() before next() is called (normally at_end() isn't meaningful on a freshly constructed TermList).

Definition at line 39 of file glass_termlist.cc.

References data, db, did, doclen, end, GlassTable::get_exact_entry(), LOGCALL_CTOR, GlassTermListTable::make_key(), pos, Xapian::Internal::str(), termlist_size, GlassDatabase::termlist_table, and unpack_uint().

Member Function Documentation

◆ accumulate_stats()

void GlassTermList::accumulate_stats ( Xapian::Internal::ExpandStats & stats ) const

virtual

Collate weighting information for the current term.

Reimplemented from Xapian::TermIterator::Internal.

Definition at line 112 of file glass_termlist.cc.

References Xapian::Internal::ExpandStats::accumulate(), Assert, at_end(), current_wdf, db, doclen, GlassDatabase::get_doccount(), get_termfreq(), LOGCALL_VOID, and Xapian::TermIterator::Internal::shard_index.

◆ at_end()

bool GlassTermList::at_end ( ) const

virtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 200 of file glass_termlist.cc.

References LOGCALL, pos, and RETURN.

Referenced by accumulate_stats(), GlassWritableDatabase::delete_document(), next(), and GlassWritableDatabase::replace_document().

◆ get_approx_size()

Xapian::termcount GlassTermList::get_approx_size ( ) const

virtual

Return approximate size of this termlist.

For a GlassTermList, this value will always be exact.

Implements Xapian::TermIterator::Internal.

Definition at line 105 of file glass_termlist.cc.

References LOGCALL, RETURN, and termlist_size.

Referenced by GlassWritableDatabase::get_unique_terms().

◆ get_doclength()

Xapian::termcount GlassTermList::get_doclength ( ) const

Return the length of this document.

This is a non-virtual method, used by GlassDatabase.

Definition at line 88 of file glass_termlist.cc.

References doclen, LOGCALL, and RETURN.

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

◆ get_termfreq()

Xapian::doccount GlassTermList::get_termfreq ( ) const

virtual

Return the term frequency for the term at the current position.

In order to be able to support updating databases efficiently, we can't store this value in the termlist table, so it has to be read from the postlist table, which is relatively expensive (compared to reading the wdf for example).

Implements Xapian::TermIterator::Internal.

Definition at line 135 of file glass_termlist.cc.

References current_term, current_termfreq, db, GlassDatabase::get_freqs(), LOGCALL, and RETURN.

Referenced by accumulate_stats().

◆ get_termname()

string GlassTermList::get_termname ( ) const

virtual

Return the termname at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 121 of file glass_termlist.cc.

References current_term, LOGCALL, and RETURN.

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

◆ get_unique_terms()

Xapian::termcount GlassTermList::get_unique_terms ( ) const

Return the number of unique terms.

This is a non-virtual method, used by GlassDatabase.

Definition at line 95 of file glass_termlist.cc.

References doclen, LOGCALL, RETURN, and termlist_size.

◆ get_wdf()

Xapian::termcount GlassTermList::get_wdf ( ) const

virtual

Return the wdf for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 128 of file glass_termlist.cc.

References current_wdf, LOGCALL, and RETURN.

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

◆ next()

TermList * GlassTermList::next ( )

virtual

Advance the current position to the next term in the termlist.

The list starts before the first term in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position.