xapian-core  1.4.21
Public Member Functions | Public Attributes | Private Attributes | List of all members
StringAndFreqTermList Class Referencefinal

A termlist iterator over a vector of StringAndFrequency objects. More...

+ Inheritance diagram for StringAndFreqTermList:
+ Collaboration diagram for StringAndFreqTermList:

Public Member Functions

void init ()
 init should be called after the values have been set, but before iteration begins. More...
 
string get_termname () const
 Return the termname at the current position. More...
 
Xapian::doccount get_termfreq () const
 Return the term frequency for the term at the current position. More...
 
TermListnext ()
 Advance the current position to the next term in the termlist. More...
 
TermListskip_to (const 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 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...
 
Xapian::PositionIterator positionlist_begin () const
 Return a PositionIterator 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...
 
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...
 

Public Attributes

vector< StringAndFrequencyvalues
 
- 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...
 

Private Attributes

vector< StringAndFrequency >::const_iterator it
 
bool started
 

Additional Inherited Members

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

Detailed Description

A termlist iterator over a vector of StringAndFrequency objects.

Definition at line 190 of file matchspy.cc.

Member Function Documentation

◆ at_end()

bool StringAndFreqTermList::at_end ( ) const
inlinevirtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 235 of file matchspy.cc.

References Assert.

◆ get_approx_size()

Xapian::termcount StringAndFreqTermList::get_approx_size ( ) const
inlinevirtual

Return approximate size of this termlist.

Implements Xapian::TermIterator::Internal.

Definition at line 240 of file matchspy.cc.

References unsupported_method().

◆ get_termfreq()

Xapian::doccount StringAndFreqTermList::get_termfreq ( ) const
inlinevirtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 211 of file matchspy.cc.

References Assert.

◆ get_termname()

string StringAndFreqTermList::get_termname ( ) const
inlinevirtual

Return the termname at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 205 of file matchspy.cc.

References Assert.

◆ get_wdf()

Xapian::termcount StringAndFreqTermList::get_wdf ( ) const
inlinevirtual

Return the wdf for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 241 of file matchspy.cc.

References unsupported_method().

◆ init()

void StringAndFreqTermList::init ( )
inline

init should be called after the values have been set, but before iteration begins.

Definition at line 200 of file matchspy.cc.

◆ next()

TermList* StringAndFreqTermList::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
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::TermIterator::Internal.

Definition at line 217 of file matchspy.cc.

References Assert.

◆ positionlist_begin()

Xapian::PositionIterator StringAndFreqTermList::positionlist_begin ( ) const
inlinevirtual

Return a PositionIterator for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 242 of file matchspy.cc.

References unsupported_method().

◆ positionlist_count()

Xapian::termcount StringAndFreqTermList::positionlist_count ( ) const
inlinevirtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 246 of file matchspy.cc.

References unsupported_method().

◆ skip_to()

TermList* StringAndFreqTermList::skip_to ( const string &  term)
inlinevirtual

Skip forward to the specified term.

If the specified term isn't in the list, position ourselves on the first term after tname (or at_end() if no terms after tname exist).

Implements Xapian::TermIterator::Internal.

Definition at line 227 of file matchspy.cc.

Member Data Documentation

◆ it

vector<StringAndFrequency>::const_iterator StringAndFreqTermList::it
private

Definition at line 192 of file matchspy.cc.

◆ started

bool StringAndFreqTermList::started
private

Definition at line 193 of file matchspy.cc.

◆ values

vector<StringAndFrequency> StringAndFreqTermList::values

Definition at line 195 of file matchspy.cc.


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