xapian-core  1.4.21
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SlowValueList Class Reference

Slow implementation for backends which don't streamed values. More...

#include <slowvaluelist.h>

+ Inheritance diagram for SlowValueList:
+ Collaboration diagram for SlowValueList:

Public Member Functions

 SlowValueList (const Xapian::Database::Internal *db_, Xapian::valueno slot_)
 
Xapian::docid get_docid () const
 Return the docid at the current position. More...
 
std::string get_value () const
 Return the value at the current position. More...
 
Xapian::valueno get_valueno () const
 Return the value slot for the current position/this iterator. More...
 
bool at_end () const
 Return true if the current position is past the last entry in this list. More...
 
void next ()
 Advance the current position to the next document in the value stream. More...
 
void skip_to (Xapian::docid)
 Skip forward to the specified docid. More...
 
bool check (Xapian::docid did)
 Check if the specified docid occurs in this valuestream. More...
 
std::string get_description () const
 Return a string description of this object. More...
 
- Public Member Functions inherited from Xapian::ValueIterator::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...
 
- Public Member Functions inherited from Xapian::Internal::intrusive_base
 intrusive_base ()
 Construct with no references. More...
 

Private Member Functions

void operator= (const SlowValueList &)
 Don't allow assignment. More...
 
 SlowValueList (const SlowValueList &)
 Don't allow copying. More...
 

Private Attributes

Xapian::Internal::intrusive_ptr< const Xapian::Database::Internaldb
 The subdatabase. More...
 
Xapian::docid last_docid
 The last docid in the database, or 0 if we're at_end. More...
 
Xapian::valueno slot
 The value slot we're iterating over. More...
 
std::string current_value
 The value at the current position. More...
 
Xapian::docid current_did
 The document id at the current position. More...
 

Additional Inherited Members

- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from Xapian::ValueIterator::Internal
 Internal ()
 Only constructable as a base class for derived classes. More...
 

Detailed Description

Slow implementation for backends which don't streamed values.

Used by inmemory and remote backends.

Definition at line 32 of file slowvaluelist.h.

Constructor & Destructor Documentation

◆ SlowValueList() [1/2]

SlowValueList::SlowValueList ( const SlowValueList )
private

Don't allow copying.

◆ SlowValueList() [2/2]

SlowValueList::SlowValueList ( const Xapian::Database::Internal db_,
Xapian::valueno  slot_ 
)
inline

Member Function Documentation

◆ at_end()

bool SlowValueList::at_end ( ) const
virtual

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

Implements Xapian::ValueIterator::Internal.

Definition at line 54 of file slowvaluelist.cc.

Referenced by SlowValueList().

◆ check()

bool SlowValueList::check ( Xapian::docid  did)
virtual

Check if the specified docid occurs in this valuestream.

The caller is required to ensure that the specified docid actually exists in the database.

This method acts like skip_to() if that can be done at little extra cost, in which case it then returns true.

Otherwise it simply checks if a particular docid is present. If it is, it returns true. If it isn't, it returns false, and leaves the position unspecified (and hence the result of calling methods which depend on the current position, such as get_docid(), are also unspecified). In this state, next() will advance to the first matching position after docid, and skip_to() will act as it would if the position was the first matching position after docid.

The default implementation calls skip_to().

Reimplemented from Xapian::ValueIterator::Internal.

Definition at line 96 of file slowvaluelist.cc.

Referenced by SlowValueList().

◆ get_description()

string SlowValueList::get_description ( ) const
virtual

Return a string description of this object.

Implements Xapian::ValueIterator::Internal.

Definition at line 124 of file slowvaluelist.cc.

References description_append(), and Xapian::Internal::str().

Referenced by SlowValueList().

◆ get_docid()

Xapian::docid SlowValueList::get_docid ( ) const
virtual

Return the docid at the current position.

Implements Xapian::ValueIterator::Internal.

Definition at line 36 of file slowvaluelist.cc.

Referenced by SlowValueList().

◆ get_value()

string SlowValueList::get_value ( ) const
virtual

Return the value at the current position.

Implements Xapian::ValueIterator::Internal.

Definition at line 42 of file slowvaluelist.cc.

Referenced by SlowValueList().

◆ get_valueno()

Xapian::valueno SlowValueList::get_valueno ( ) const
virtual

Return the value slot for the current position/this iterator.

Implements Xapian::ValueIterator::Internal.

Definition at line 48 of file slowvaluelist.cc.

Referenced by SlowValueList().

◆ next()

void SlowValueList::next ( )
virtual

Advance the current position to the next document in the value stream.

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

Implements Xapian::ValueIterator::Internal.

Definition at line 60 of file slowvaluelist.cc.

Referenced by SlowValueList().

◆ operator=()

void SlowValueList::operator= ( const SlowValueList )
private

Don't allow assignment.

◆ skip_to()

void SlowValueList::skip_to ( Xapian::docid  )
virtual

Skip forward to the specified docid.

If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present).

Implements Xapian::ValueIterator::Internal.

Definition at line 88 of file slowvaluelist.cc.

Referenced by SlowValueList().

Member Data Documentation

◆ current_did

Xapian::docid SlowValueList::current_did
private

The document id at the current position.

Definition at line 52 of file slowvaluelist.h.

◆ current_value

std::string SlowValueList::current_value
private

The value at the current position.

Definition at line 49 of file slowvaluelist.h.

◆ db

The subdatabase.

Definition at line 40 of file slowvaluelist.h.

◆ last_docid

Xapian::docid SlowValueList::last_docid
private

The last docid in the database, or 0 if we're at_end.

Definition at line 43 of file slowvaluelist.h.

◆ slot

Xapian::valueno SlowValueList::slot
private

The value slot we're iterating over.

Definition at line 46 of file slowvaluelist.h.


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