xapian-core  1.4.19
Public Member Functions | Public Attributes | List of all members
Xapian::Internal::MSetItem Class Reference

An item resulting from a query. More...

#include <omenquireinternal.h>

+ Collaboration diagram for Xapian::Internal::MSetItem:

Public Member Functions

 MSetItem (double wt_, Xapian::docid did_)
 
 MSetItem (double wt_, Xapian::docid did_, const string &key_)
 
 MSetItem (double wt_, Xapian::docid did_, const string &key_, Xapian::doccount collapse_count_)
 
void swap (MSetItem &o)
 
string get_description () const
 Return a string describing this object. More...
 

Public Attributes

double wt
 Weight calculated. More...
 
Xapian::docid did
 Document id. More...
 
string collapse_key
 Value which was used to collapse upon. More...
 
Xapian::doccount collapse_count
 Count of collapses done on collapse_key so far. More...
 
string sort_key
 Used when sorting by value. More...
 

Detailed Description

An item resulting from a query.

This item contains the document id, and the weight calculated for the document.

Definition at line 58 of file omenquireinternal.h.

Constructor & Destructor Documentation

◆ MSetItem() [1/3]

Xapian::Internal::MSetItem::MSetItem ( double  wt_,
Xapian::docid  did_ 
)
inline

Definition at line 60 of file omenquireinternal.h.

◆ MSetItem() [2/3]

Xapian::Internal::MSetItem::MSetItem ( double  wt_,
Xapian::docid  did_,
const string &  key_ 
)
inline

Definition at line 63 of file omenquireinternal.h.

◆ MSetItem() [3/3]

Xapian::Internal::MSetItem::MSetItem ( double  wt_,
Xapian::docid  did_,
const string &  key_,
Xapian::doccount  collapse_count_ 
)
inline

Definition at line 66 of file omenquireinternal.h.

Member Function Documentation

◆ get_description()

string Xapian::Internal::MSetItem::get_description ( ) const

Return a string describing this object.

Definition at line 149 of file omenquire.cc.

References Xapian::Internal::str().

◆ swap()

void Xapian::Internal::MSetItem::swap ( MSetItem o)
inline

Definition at line 71 of file omenquireinternal.h.

References collapse_count, collapse_key, did, sort_key, and wt.

Member Data Documentation

◆ collapse_count

Xapian::doccount Xapian::Internal::MSetItem::collapse_count

Count of collapses done on collapse_key so far.

This is normally 0, and goes up for each collapse done It is not necessarily an indication of how many collapses might be done if an exhaustive match was done

Definition at line 104 of file omenquireinternal.h.

Referenced by serialise_mset(), and swap().

◆ collapse_key

string Xapian::Internal::MSetItem::collapse_key

Value which was used to collapse upon.

If the collapse option is not being used, this will always have a null value.

If the collapse option is in use, this will contain the collapse key's value for this particular item. If the key is not present for this item, the value will be a null string. Only one instance of each key value (apart from the null string) will be present in the items in the returned Xapian::MSet.

Definition at line 96 of file omenquireinternal.h.

Referenced by MultiMatch::get_mset(), Collapser::process(), serialise_mset(), and swap().

◆ did

Xapian::docid Xapian::Internal::MSetItem::did

◆ sort_key

string Xapian::Internal::MSetItem::sort_key

◆ wt

double Xapian::Internal::MSetItem::wt

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