ValueCountTermList Class Reference

A termlist iterator over the contents of a ValueCountMatchSpy. More...

Inheritance diagram for ValueCountTermList:

Collaboration diagram for ValueCountTermList:

Public Member Functions
	ValueCountTermList (ValueCountMatchSpy::Internal *spy_)
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 (string_view term)
	Skip forward to the specified term. More...
Xapian::termcount	get_approx_size () const
	Return approximate size of this termlist. More...
Xapian::termcount	get_wdf () const
	Return the wdf for the term at the current position. More...
PositionList *	positionlist_begin () const
	Return PositionList for the current position. More...
Xapian::termcount	positionlist_count () const
	Return the length of the position list 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 void	accumulate_stats (Xapian::Internal::ExpandStats &stats) const
	Collate weighting information for the current term. More...
const std::string &	get_termname () const
	Return the termname at the current position. More...
virtual const Xapian::VecCOW< Xapian::termpos > *	get_vec_termpos () const
	Get pointer to VecCOW<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 Attributes
map< string, Xapian::doccount >::const_iterator	it
bool	started
intrusive_ptr< Xapian::ValueCountMatchSpy::Internal >	spy

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...
Protected Attributes inherited from Xapian::TermIterator::Internal
std::string	current_term
	The current term. More...

Detailed Description

A termlist iterator over the contents of a ValueCountMatchSpy.

Definition at line 92 of file matchspy.cc.

Constructor & Destructor Documentation

ValueCountTermList()

ValueCountTermList::ValueCountTermList ( ValueCountMatchSpy::Internal *  spy_ )

inlineexplicit

Definition at line 99 of file matchspy.cc.

Member Function Documentation

get_approx_size()

Xapian::termcount ValueCountTermList::get_approx_size ( ) const

inlinevirtual

Return approximate size of this termlist.

Implements Xapian::TermIterator::Internal.

Definition at line 138 of file matchspy.cc.

References unsupported_method().

get_termfreq()

Xapian::doccount ValueCountTermList::get_termfreq ( ) const

inlinevirtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 106 of file matchspy.cc.

References Assert.

get_wdf()

Xapian::termcount ValueCountTermList::get_wdf ( ) const

inlinevirtual

Return the wdf for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 139 of file matchspy.cc.

References unsupported_method().

next()

TermList* ValueCountTermList::next ( )

inlinevirtual

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.

Returns

Normally returns NULL to indicate success. If the end has been reached, returns this; if another 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::TermIterator::Internal.

Definition at line 112 of file matchspy.cc.

References Assert.

positionlist_begin()

PositionList* ValueCountTermList::positionlist_begin ( ) const

inlinevirtual

Return PositionList for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 140 of file matchspy.cc.

References unsupported_method().

positionlist_count()

Xapian::termcount ValueCountTermList::positionlist_count ( ) const

inlinevirtual

Return the length of the position list for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 141 of file matchspy.cc.

References unsupported_method().

skip_to()

TermList* ValueCountTermList::skip_to ( string_view  term )

inlinevirtual

Skip forward to the specified term.

If the specified term isn't in the list, position ourselves on the first term after term.

Returns

Normally returns NULL to indicate success. If no terms after term exist, returns this; if another 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::TermIterator::Internal.

Definition at line 126 of file matchspy.cc.

References term.

Member Data Documentation

it

map<string, Xapian::doccount>::const_iterator ValueCountTermList::it

private

Definition at line 94 of file matchspy.cc.

spy

intrusive_ptr<Xapian::ValueCountMatchSpy::Internal> ValueCountTermList::spy

private

Definition at line 96 of file matchspy.cc.

started

bool ValueCountTermList::started

private

Definition at line 95 of file matchspy.cc.

---

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

• api/matchspy.cc