xapian-core  2.0.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
GlassMetadataTermList Class Reference

#include <glass_metadata.h>

+ Inheritance diagram for GlassMetadataTermList:
+ Collaboration diagram for GlassMetadataTermList:

Public Member Functions

 GlassMetadataTermList (Xapian::Internal::intrusive_ptr< const Xapian::Database::Internal > database_, GlassCursor *cursor_, std::string_view prefix_)
 
 ~GlassMetadataTermList ()
 
Xapian::termcount get_approx_size () const
 Return approximate size of this termlist. More...
 
Xapian::doccount get_termfreq () const
 Return the term frequency for the term at the current position. More...
 
TermListnext ()
 Advance to the next term in the list. More...
 
TermListskip_to (std::string_view key)
 Advance to the first key which is >= key. More...
 
- Public Member Functions inherited from AllTermsList
virtual Xapian::termcount get_wdf () const
 Return the wdf for the term at the current position. More...
 
virtual Xapian::termcount positionlist_count () const
 Return true if the current position is past the last term in this list. More...
 
virtual PositionListpositionlist_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 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 Member Functions

 GlassMetadataTermList (const GlassMetadataTermList &)
 Copying is not allowed. More...
 
void operator= (const GlassMetadataTermList &)
 Assignment is not allowed. More...
 

Private Attributes

Xapian::Internal::intrusive_ptr< const Xapian::Database::Internaldatabase
 Keep a reference to our database to stop it being deleted. More...
 
GlassCursorcursor
 A cursor which runs through the postlist table reading metadata keys. More...
 
std::string prefix
 The prefix that all returned keys must have. 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 AllTermsList
 AllTermsList ()
 Only constructable as a base class for derived classes. 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

Definition at line 37 of file glass_metadata.h.

Constructor & Destructor Documentation

◆ GlassMetadataTermList() [1/2]

GlassMetadataTermList::GlassMetadataTermList ( const GlassMetadataTermList )
private

Copying is not allowed.

◆ GlassMetadataTermList() [2/2]

GlassMetadataTermList::GlassMetadataTermList ( Xapian::Internal::intrusive_ptr< const Xapian::Database::Internal database_,
GlassCursor cursor_,
std::string_view  prefix_ 
)

Definition at line 41 of file glass_metadata.cc.

References Assert, cursor, GlassCursor::find_entry_lt(), LOGCALL_CTOR, and prefix.

◆ ~GlassMetadataTermList()

GlassMetadataTermList::~GlassMetadataTermList ( )

Definition at line 55 of file glass_metadata.cc.

References cursor, and LOGCALL_DTOR.

Member Function Documentation

◆ get_approx_size()

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

Return approximate size of this termlist.

Implements AllTermsList.

Definition at line 62 of file glass_metadata.cc.

◆ get_termfreq()

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

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

Not meaningful for a GlassMetadataTermList.

Implements AllTermsList.

Definition at line 70 of file glass_metadata.cc.

◆ next()

TermList * GlassMetadataTermList::next ( )
virtual

◆ operator=()

void GlassMetadataTermList::operator= ( const GlassMetadataTermList )
private

Assignment is not allowed.

◆ skip_to()

TermList * GlassMetadataTermList::skip_to ( std::string_view  key)
virtual

Member Data Documentation

◆ cursor

GlassCursor* GlassMetadataTermList::cursor
private

A cursor which runs through the postlist table reading metadata keys.

Definition at line 49 of file glass_metadata.h.

Referenced by GlassMetadataTermList(), next(), skip_to(), and ~GlassMetadataTermList().

◆ database

Xapian::Internal::intrusive_ptr<const Xapian::Database::Internal> GlassMetadataTermList::database
private

Keep a reference to our database to stop it being deleted.

Definition at line 45 of file glass_metadata.h.

◆ prefix

std::string GlassMetadataTermList::prefix
private

The prefix that all returned keys must have.

Definition at line 53 of file glass_metadata.h.

Referenced by GlassMetadataTermList(), next(), and skip_to().


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