MyPostingSource Class Reference
Public Member Functions | |
| MyPostingSource () | |
| PostingSource * | clone () const |
| Clone the posting source. | |
| void | append_docweight (Xapian::docid did, Xapian::weight wt) |
| void | init (const Xapian::Database &) |
| Set this PostingSource to the start of the list of postings. | |
| Xapian::weight | get_weight () const |
| Return the weight contribution for the current document. | |
| Xapian::doccount | get_termfreq_min () const |
| A lower bound on the number of documents this object can return. | |
| Xapian::doccount | get_termfreq_est () const |
| An estimate of the number of documents this object can return. | |
| Xapian::doccount | get_termfreq_max () const |
| An upper bound on the number of documents this object can return. | |
| void | next (Xapian::weight) |
| Advance the current position to the next matching document. | |
| bool | at_end () const |
| Return true if the current position is past the last entry in this list. | |
| Xapian::docid | get_docid () const |
| Return the current docid. | |
| string | get_description () const |
| Return a string describing this object. | |
Private Member Functions | |
| MyPostingSource (const vector< pair< Xapian::docid, Xapian::weight > > &weights_, Xapian::weight max_wt) | |
Private Attributes | |
| vector< pair< Xapian::docid, Xapian::weight > > | weights |
| vector< pair< Xapian::docid, Xapian::weight > >::const_iterator | i |
| bool | started |
Detailed Description
Definition at line 71 of file api_percentages.cc.
Constructor & Destructor Documentation
| MyPostingSource::MyPostingSource | ( | const vector< pair< Xapian::docid, Xapian::weight > > & | weights_, | |
| Xapian::weight | max_wt | |||
| ) | [inline, private] |
Definition at line 76 of file api_percentages.cc.
References Xapian::PostingSource::set_maxweight().
| MyPostingSource::MyPostingSource | ( | ) | [inline] |
Member Function Documentation
| void MyPostingSource::append_docweight | ( | Xapian::docid | did, | |
| Xapian::weight | wt | |||
| ) | [inline] |
Definition at line 91 of file api_percentages.cc.
References Xapian::PostingSource::get_maxweight(), Xapian::PostingSource::set_maxweight(), and weights.
Referenced by DEFINE_TESTCASE().
| bool MyPostingSource::at_end | ( | ) | const [inline, virtual] |
Return true if the current position is past the last entry in this list.
At least one of next(), skip_to() or check() will be called before this method is first called.
Implements Xapian::PostingSource.
Definition at line 113 of file api_percentages.cc.
| PostingSource* MyPostingSource::clone | ( | ) | const [inline, virtual] |
Clone the posting source.
The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be in the same iteration position as the original: the matcher will always call init() on the clone before attempting to move the iterator, or read the information about the current position of the iterator.
This may return NULL to indicate that cloning is not supported. In this case, the PostingSource may only be used with a single-database search.
The default implementation returns NULL.
Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static operator delete method in your subclass as shown here: http://trac.xapian.org/ticket/554#comment:1
Reimplemented from Xapian::PostingSource.
Definition at line 86 of file api_percentages.cc.
References Xapian::PostingSource::get_maxweight(), MyPostingSource(), and weights.
| string MyPostingSource::get_description | ( | ) | const [inline, virtual] |
Return a string describing this object.
This default implementation returns a generic answer. This default it provided to avoid forcing those deriving their own PostingSource subclass from having to implement this (they may not care what get_description() gives for their subclass).
Reimplemented from Xapian::PostingSource.
Definition at line 119 of file api_percentages.cc.
| Xapian::docid MyPostingSource::get_docid | ( | ) | const [inline, virtual] |
Return the current docid.
This method may assume that it will only be called when there is a "current document". See get_weight() for details.
Note: in the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the init() method for details.
Implements Xapian::PostingSource.
Definition at line 117 of file api_percentages.cc.
References i.
| Xapian::doccount MyPostingSource::get_termfreq_est | ( | ) | const [inline, virtual] |
An estimate of the number of documents this object can return.
It must always be true that:
get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()
Xapian will always call init() on a PostingSource before calling this for the first time.
Implements Xapian::PostingSource.
Definition at line 101 of file api_percentages.cc.
References weights.
| Xapian::doccount MyPostingSource::get_termfreq_max | ( | ) | const [inline, virtual] |
An upper bound on the number of documents this object can return.
Xapian will always call init() on a PostingSource before calling this for the first time.
Implements Xapian::PostingSource.
Definition at line 102 of file api_percentages.cc.
References weights.
| Xapian::doccount MyPostingSource::get_termfreq_min | ( | ) | const [inline, virtual] |
A lower bound on the number of documents this object can return.
Xapian will always call init() on a PostingSource before calling this for the first time.
Implements Xapian::PostingSource.
Definition at line 100 of file api_percentages.cc.
References weights.
| Xapian::weight MyPostingSource::get_weight | ( | ) | const [inline, virtual] |
Return the weight contribution for the current document.
This default implementation always returns 0, for convenience when implementing "weight-less" PostingSource subclasses.
This method may assume that it will only be called when there is a "current document". In detail: Xapian will always call init() on a PostingSource before calling this for the first time. It will also only call this if the PostingSource reports that it is pointing to a valid document (ie, it will not call it before calling at least one of next(), skip_to() or check(), and will ensure that the PostingSource is not at the end by calling at_end()).
Reimplemented from Xapian::PostingSource.
Definition at line 98 of file api_percentages.cc.
References i.
| void MyPostingSource::init | ( | const Xapian::Database & | db | ) | [inline, virtual] |
Set this PostingSource to the start of the list of postings.
This is called automatically by the matcher prior to each query being processed.
If a PostingSource is used for multiple searches, init() will therefore be called multiple times, and must handle this by using the database passed in the most recent call.
- Parameters:
-
db The database which the PostingSource should iterate through.
Note: in the case of a multi-database search, a separate PostingSource will be used for each database (the separate PostingSources will be obtained using clone()), and each PostingSource will be passed one of the sub-databases as the db parameter here. The db parameter will therefore always refer to a single database. All docids passed to, or returned from, the PostingSource refer to docids in that single database, rather than in the multi-database.
Implements Xapian::PostingSource.
Definition at line 96 of file api_percentages.cc.
References started.
| void MyPostingSource::next | ( | Xapian::weight | min_wt | ) | [inline, virtual] |
Advance the current position to the next matching document.
The PostingSource starts before the first entry in the list, so next() must be called before any methods which need the context of the current position.
Xapian will always call init() on a PostingSource before calling this for the first time.
- Parameters:
-
min_wt The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).
Implements Xapian::PostingSource.
Definition at line 104 of file api_percentages.cc.
Member Data Documentation
vector<pair<Xapian::docid, Xapian::weight> >::const_iterator MyPostingSource::i [private] |
Definition at line 73 of file api_percentages.cc.
Referenced by at_end(), get_docid(), get_weight(), and next().
bool MyPostingSource::started [private] |
vector<pair<Xapian::docid, Xapian::weight> > MyPostingSource::weights [private] |
Definition at line 72 of file api_percentages.cc.
Referenced by append_docweight(), at_end(), clone(), get_termfreq_est(), get_termfreq_max(), get_termfreq_min(), and next().
The documentation for this class was generated from the following file:
- tests/api_percentages.cc