xapian-core  1.4.19
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
InMemoryTermList Class Reference

#include <inmemory_database.h>

+ Inheritance diagram for InMemoryTermList:
+ Collaboration diagram for InMemoryTermList:

Public Member Functions

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...
 
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...
 
TermListnext ()
 Advance the current position to the next term in the termlist. More...
 
TermListskip_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

 InMemoryTermList (Xapian::Internal::intrusive_ptr< const InMemoryDatabase > db, Xapian::docid did, const InMemoryDoc &doc, Xapian::termcount len)
 

Private Attributes

vector< InMemoryTermEntry >::const_iterator pos
 
vector< InMemoryTermEntry >::const_iterator end
 
Xapian::termcount terms
 
bool started
 
Xapian::Internal::intrusive_ptr< const InMemoryDatabasedb
 
Xapian::docid did
 
Xapian::termcount document_length
 

Friends

class InMemoryDatabase
 

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

Definition at line 218 of file inmemory_database.h.

Constructor & Destructor Documentation

◆ InMemoryTermList()

InMemoryTermList::InMemoryTermList ( Xapian::Internal::intrusive_ptr< const InMemoryDatabase db,
Xapian::docid  did,
const InMemoryDoc doc,
Xapian::termcount  len 
)
private

Definition at line 208 of file inmemory_database.cc.

References LOGLINE, pos, and terms.

Member Function Documentation

◆ accumulate_stats()

void InMemoryTermList::accumulate_stats ( Xapian::Internal::ExpandStats stats) const
virtual

◆ at_end()

bool InMemoryTermList::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 296 of file inmemory_database.cc.

References Assert, db, end, InMemoryDatabase::is_closed(), pos, started, and InMemoryDatabase::throw_database_closed().

Referenced by accumulate_stats(), get_termfreq(), get_termname(), get_wdf(), and next().

◆ get_approx_size()

Xapian::termcount InMemoryTermList::get_approx_size ( ) const
virtual

Return approximate size of this termlist.

Implements Xapian::TermIterator::Internal.

Definition at line 241 of file inmemory_database.cc.

References db, InMemoryDatabase::is_closed(), terms, and InMemoryDatabase::throw_database_closed().

◆ get_termfreq()

Xapian::doccount InMemoryTermList::get_termfreq ( ) const
virtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 229 of file inmemory_database.cc.

References Assert, at_end(), db, InMemoryDatabase::get_freqs(), InMemoryDatabase::is_closed(), started, and InMemoryDatabase::throw_database_closed().

Referenced by accumulate_stats().

◆ get_termname()

string InMemoryTermList::get_termname ( ) const
virtual

Return the termname at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 260 of file inmemory_database.cc.

References Assert, at_end(), db, InMemoryDatabase::is_closed(), started, and InMemoryDatabase::throw_database_closed().

◆ get_wdf()

Xapian::termcount InMemoryTermList::get_wdf ( ) const
virtual

Return the wdf for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 220 of file inmemory_database.cc.

References Assert, at_end(), db, InMemoryDatabase::is_closed(), started, and InMemoryDatabase::throw_database_closed().

Referenced by accumulate_stats().

◆ next()

TermList * InMemoryTermList::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.

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 269 of file inmemory_database.cc.

References Assert, at_end(), db, InMemoryDatabase::is_closed(), pos, started, and InMemoryDatabase::throw_database_closed().

◆ positionlist_begin()

Xapian::PositionIterator InMemoryTermList::positionlist_begin ( ) const
virtual

Return a PositionIterator for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 311 of file inmemory_database.cc.

References db, did, InMemoryDatabase::is_closed(), InMemoryDatabase::open_position_list(), and InMemoryDatabase::throw_database_closed().

◆ positionlist_count()

Xapian::termcount InMemoryTermList::positionlist_count ( ) const
virtual

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

Implements Xapian::TermIterator::Internal.

Definition at line 304 of file inmemory_database.cc.

References db, did, InMemoryDatabase::is_closed(), InMemoryDatabase::positionlist_count(), and InMemoryDatabase::throw_database_closed().

◆ skip_to()

TermList * InMemoryTermList::skip_to ( const std::string &  term)
virtual

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 282 of file inmemory_database.cc.

References db, end, InMemoryDatabase::is_closed(), pos, rare, started, and InMemoryDatabase::throw_database_closed().

Friends And Related Function Documentation

◆ InMemoryDatabase

friend class InMemoryDatabase
friend

Definition at line 219 of file inmemory_database.h.

Member Data Documentation

◆ db

Xapian::Internal::intrusive_ptr<const InMemoryDatabase> InMemoryTermList::db
private

◆ did

Xapian::docid InMemoryTermList::did
private

Definition at line 228 of file inmemory_database.h.

Referenced by positionlist_begin(), and positionlist_count().

◆ document_length

Xapian::termcount InMemoryTermList::document_length
private

Definition at line 229 of file inmemory_database.h.

Referenced by accumulate_stats().

◆ end

vector<InMemoryTermEntry>::const_iterator InMemoryTermList::end
private

Definition at line 223 of file inmemory_database.h.

Referenced by at_end(), and skip_to().

◆ pos

vector<InMemoryTermEntry>::const_iterator InMemoryTermList::pos
private

Definition at line 222 of file inmemory_database.h.

Referenced by at_end(), InMemoryTermList(), next(), and skip_to().

◆ started

bool InMemoryTermList::started
private

◆ terms

Xapian::termcount InMemoryTermList::terms
private

Definition at line 224 of file inmemory_database.h.

Referenced by get_approx_size(), and InMemoryTermList().


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