Xapian::Internal::MSetItem Class Reference

An item resulting from a query. More...

#include <omenquireinternal.h>

Collaboration diagram for Xapian::Internal::MSetItem:

[legend]

List of all members.

Public Member Functions
	MSetItem (Xapian::weight wt_, Xapian::docid did_)
	MSetItem (Xapian::weight wt_, Xapian::docid did_, const string &key_)
	MSetItem (Xapian::weight 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.
Public Attributes
Xapian::weight	wt
	Weight calculated.
Xapian::docid	did
	Document id.
string	collapse_key
	Value which was used to collapse upon.
Xapian::doccount	collapse_count
	Count of collapses done on collapse_key so far.
string	sort_key
	Used when sorting by value.

---

Detailed Description

An item resulting from a query.

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

Definition at line 55 of file omenquireinternal.h.

---

Constructor & Destructor Documentation

Xapian::Internal::MSetItem::MSetItem	(	Xapian::weight	wt_,
		Xapian::docid	did_
	)			[inline]

Definition at line 57 of file omenquireinternal.h.

Xapian::Internal::MSetItem::MSetItem	(	Xapian::weight	wt_,
		Xapian::docid	did_,
		const string &	key_
	)			[inline]

Definition at line 60 of file omenquireinternal.h.

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

Definition at line 63 of file omenquireinternal.h.

---

Member Function Documentation

string Xapian::Internal::MSetItem::get_description

(

)

const

Return a string describing this object.

Definition at line 138 of file omenquire.cc.

References collapse_key, did, Xapian::Internal::str(), and wt.

void Xapian::Internal::MSetItem::swap

(

MSetItem &

o

)

[inline]

Definition at line 68 of file omenquireinternal.h.

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

---

Member Data Documentation

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 101 of file omenquireinternal.h.

Referenced by swap().

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 93 of file omenquireinternal.h.

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

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

Document id.

Definition at line 80 of file omenquireinternal.h.

Referenced by get_description(), msetcmp_by_did(), msetcmp_by_relevance_then_value(), msetcmp_by_value(), msetcmp_by_value_then_relevance(), Xapian::Enquire::Internal::read_doc(), Xapian::Enquire::Internal::request_doc(), and swap().

string Xapian::Internal::MSetItem::sort_key

Used when sorting by value.

Definition at line 104 of file omenquireinternal.h.

Referenced by MultiMatch::get_mset(), msetcmp_by_relevance_then_value(), msetcmp_by_value(), msetcmp_by_value_then_relevance(), and swap().

Xapian::weight Xapian::Internal::MSetItem::wt

Weight calculated.

Definition at line 77 of file omenquireinternal.h.

Referenced by CollapseData::add_item(), get_description(), MultiMatch::get_mset(), msetcmp_by_relevance(), msetcmp_by_relevance_then_value(), msetcmp_by_value_then_relevance(), and swap().

---

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

• common/omenquireinternal.h
• api/omenquire.cc