FlintSynonymTermList Class Reference
#include <flint_synonym.h>
Public Member Functions | |
| FlintSynonymTermList (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > database_, FlintCursor *cursor_, const string &prefix_) | |
| ~FlintSynonymTermList () | |
| Destructor. | |
| string | get_termname () const |
| Returns the current termname. | |
| Xapian::doccount | get_termfreq () const |
| Return the term frequency for the term at the current position. | |
| Xapian::termcount | get_collection_freq () const |
| Return the collection frequency for the term at the current position. | |
| TermList * | next () |
| Advance to the next term in the list. | |
| TermList * | skip_to (const string &tname) |
| Advance to the first term which is >= tname. | |
| bool | at_end () const |
| True if we're off the end of the list. | |
Private Member Functions | |
| FlintSynonymTermList (const FlintSynonymTermList &) | |
| Copying is not allowed. | |
| void | operator= (const FlintSynonymTermList &) |
| Assignment is not allowed. | |
Private Attributes | |
| Xapian::Internal::RefCntPtr < const Xapian::Database::Internal > | database |
| Keep a reference to our database to stop it being deleted. | |
| FlintCursor * | cursor |
| A cursor which runs through the synonym table reading termnames from the keys. | |
| string | prefix |
| The prefix to restrict the terms to. | |
Detailed Description
Definition at line 119 of file flint_synonym.h.
Constructor & Destructor Documentation
| FlintSynonymTermList::FlintSynonymTermList | ( | const FlintSynonymTermList & | ) | [private] |
Copying is not allowed.
| FlintSynonymTermList::FlintSynonymTermList | ( | Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > | database_, | |
| FlintCursor * | cursor_, | |||
| const string & | prefix_ | |||
| ) | [inline] |
Definition at line 138 of file flint_synonym.h.
References cursor, FlintCursor::find_entry(), FlintCursor::find_entry_lt(), and prefix.
| FlintSynonymTermList::~FlintSynonymTermList | ( | ) |
Member Function Documentation
| bool FlintSynonymTermList::at_end | ( | ) | const [virtual] |
True if we're off the end of the list.
Implements AllTermsList.
Definition at line 230 of file flint_synonym.cc.
References FlintCursor::after_end(), cursor, LOGCALL, and RETURN.
Referenced by get_termname(), next(), and skip_to().
| Xapian::termcount FlintSynonymTermList::get_collection_freq | ( | ) | const [virtual] |
Return the collection frequency for the term at the current position.
Implements AllTermsList.
Definition at line 192 of file flint_synonym.cc.
| Xapian::doccount FlintSynonymTermList::get_termfreq | ( | ) | const [virtual] |
Return the term frequency for the term at the current position.
Implements AllTermsList.
Definition at line 186 of file flint_synonym.cc.
| string FlintSynonymTermList::get_termname | ( | ) | const [virtual] |
Returns the current termname.
Either next() or skip_to() must have been called before this method can be called.
Implements AllTermsList.
Definition at line 176 of file flint_synonym.cc.
References Assert, at_end(), FlintCursor::current_key, cursor, LOGCALL, and RETURN.
| TermList * FlintSynonymTermList::next | ( | ) | [virtual] |
Advance to the next term in the list.
Implements AllTermsList.
Definition at line 198 of file flint_synonym.cc.
References FlintCursor::after_end(), Assert, at_end(), FlintCursor::current_key, cursor, LOGCALL, FlintCursor::next(), prefix, RETURN, startswith(), and FlintCursor::to_end().
| void FlintSynonymTermList::operator= | ( | const FlintSynonymTermList & | ) | [private] |
Assignment is not allowed.
| TermList * FlintSynonymTermList::skip_to | ( | const string & | tname | ) | [virtual] |
Advance to the first term which is >= tname.
Implements AllTermsList.
Definition at line 213 of file flint_synonym.cc.
References FlintCursor::after_end(), Assert, at_end(), FlintCursor::current_key, cursor, FlintCursor::find_entry_ge(), LOGCALL, prefix, RETURN, startswith(), and FlintCursor::to_end().
Member Data Documentation
FlintCursor* FlintSynonymTermList::cursor [private] |
A cursor which runs through the synonym table reading termnames from the keys.
Definition at line 132 of file flint_synonym.h.
Referenced by at_end(), FlintSynonymTermList(), get_termname(), next(), skip_to(), and ~FlintSynonymTermList().
Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> FlintSynonymTermList::database [private] |
Keep a reference to our database to stop it being deleted.
Definition at line 127 of file flint_synonym.h.
string FlintSynonymTermList::prefix [private] |
The prefix to restrict the terms to.
Definition at line 135 of file flint_synonym.h.
Referenced by FlintSynonymTermList(), next(), and skip_to().
The documentation for this class was generated from the following files:
- backends/flint/flint_synonym.h
- backends/flint/flint_synonym.cc