#include <flint_postlist.h>
Inheritance diagram for FlintPostList:
Public Member Functions | |
| FlintPostList (Xapian::Internal::RefCntPtr< const FlintDatabase > this_db_, const string &tname) | |
| Default constructor. | |
| ~FlintPostList () | |
| Destructor. | |
| Xapian::doccount | get_termfreq () const |
| Returns number of docs indexed by this term. | |
| Xapian::docid | get_docid () const |
| Returns the current docid. | |
| Xapian::doclength | get_doclength () const |
| Returns the length of current document. | |
| Xapian::termcount | get_wdf () const |
| Returns the Within Document Frequency of the term in the current document. | |
| PositionList * | read_position_list () |
| Get the list of positions of the term in the current document. | |
| PositionList * | open_position_list () const |
| Get the list of positions of the term in the current document. | |
| PostList * | next (Xapian::weight w_min) |
| Move to the next document. | |
| PostList * | skip_to (Xapian::docid desired_did, Xapian::weight w_min) |
| Skip to next document with docid >= docid. | |
| bool | at_end () const |
| Return true if and only if we're off the end of the list. | |
| std::string | get_description () const |
| Get a description of the document. | |
Static Public Member Functions | |
| static void | read_number_of_entries (const char **posptr, const char *end, Xapian::termcount *number_of_entries_ptr, Xapian::termcount *collection_freq_ptr) |
| Read the number of entries and the collection frequency. | |
Protected Attributes | |
| Xapian::Internal::RefCntPtr< const FlintDatabase > | this_db |
| The database we are searching. | |
| string | tname |
| The termname for this postlist. | |
| bool | have_started |
| Whether we've started reading the list yet. | |
| FlintPositionList | positionlist |
| The position list object for this posting list. | |
Private Member Functions | |
| FlintPostList (const FlintPostList &) | |
| Copying is not allowed. | |
| void | operator= (const FlintPostList &) |
| Assignment is not allowed. | |
| bool | next_in_chunk () |
| Move to the next item in the chunk, if possible. | |
| void | next_chunk () |
| Move to the next chunk. | |
| bool | current_chunk_contains (Xapian::docid desired_did) |
| Return true if the given document ID lies in the range covered by the current chunk. | |
| void | move_to_chunk_containing (Xapian::docid desired_did) |
| Move to chunk containing the specified document ID. | |
| bool | move_forward_in_chunk_to_at_least (Xapian::docid desired_did) |
| Scan forward in the current chunk for the specified document ID. | |
Private Attributes | |
| AutoPtr< FlintCursor > | cursor |
| Cursor pointing to current chunk of postlist. | |
| bool | is_last_chunk |
| True if this is the last chunk. | |
| Xapian::docid | first_did_in_chunk |
| The first document id in this chunk. | |
| Xapian::docid | last_did_in_chunk |
| The last document id in this chunk. | |
| const char * | pos |
| Position of iteration through current chunk. | |
| const char * | end |
| Pointer to byte after end of current chunk. | |
| Xapian::docid | did |
| Document id we're currently at. | |
| flint_doclen_t | doclength |
| The (absolute) length of the current document. | |
| Xapian::termcount | wdf |
| The wdf of the current document. | |
| bool | is_at_end |
| Whether we've run off the end of the list yet. | |
| Xapian::doccount | number_of_entries |
| The number of entries in the posting list. | |
Definition at line 105 of file flint_postlist.h.
| FlintPostList::FlintPostList | ( | const FlintPostList & | ) | [private] |
Copying is not allowed.
| FlintPostList::FlintPostList | ( | Xapian::Internal::RefCntPtr< const FlintDatabase > | this_db_, | |
| const string & | tname_ | |||
| ) |
Default constructor.
Split into chunks. Key for first chunk is the termname (encoded as length : name). Key for subsequent chunks is the same, followed by the document ID of the first document in the chunk (encoded as length of representation in first byte, and then docid).
A chunk (except for the first chunk) contains:
1) bool - true if this is the last chunk. 2) difference between final docid in chunk and first docid. 3) wdf, then doclength of first item. 4) increment in docid to next item, followed by wdf and doclength of item 5) (4) repeatedly.
The first chunk begins with the number of entries, the collection frequency, then the docid of the first document, then has the header of a standard chunk.
Definition at line 656 of file flint_postlist.cc.
References cursor, DEBUGCALL, did, doclength, end, first_did_in_chunk, Xapian::Internal::RefCntPtr< T >::get(), is_at_end, is_last_chunk, last_did_in_chunk, FlintPostListTable::make_key(), number_of_entries, pos, read_start_of_chunk(), read_start_of_first_chunk(), read_wdf_and_length(), tname, and wdf.
| FlintPostList::~FlintPostList | ( | ) |
| void FlintPostList::operator= | ( | const FlintPostList & | ) | [private] |
Assignment is not allowed.
| bool FlintPostList::next_in_chunk | ( | ) | [private] |
Move to the next item in the chunk, if possible.
If already at the end of the chunk, returns false.
Definition at line 694 of file flint_postlist.cc.
References Assert, DEBUGCALL, did, doclength, end, last_did_in_chunk, pos, read_did_increase(), read_wdf_and_length(), RETURN, and wdf.
Referenced by move_forward_in_chunk_to_at_least(), and next().
| void FlintPostList::next_chunk | ( | ) | [private] |
Move to the next chunk.
If there are no more chunks in this postlist, this will set is_at_end to true.
Definition at line 711 of file flint_postlist.cc.
References check_tname_in_key_lite(), cursor, DEBUGCALL, did, doclength, end, first_did_in_chunk, is_at_end, is_last_chunk, last_did_in_chunk, om_tostring(), pos, read_start_of_chunk(), read_wdf_and_length(), report_read_error(), tname, unpack_uint_preserving_sort(), and wdf.
Referenced by move_to_chunk_containing(), and next().
| bool FlintPostList::current_chunk_contains | ( | Xapian::docid | desired_did | ) | [private] |
Return true if the given document ID lies in the range covered by the current chunk.
This does not say whether the document ID is actually present. It will return false if the document ID is greater than the last document ID in the chunk, even if it is less than the first document ID in the next chunk: it is possible for no chunk to contain a particular document ID.
Definition at line 792 of file flint_postlist.cc.
References DEBUGCALL, first_did_in_chunk, last_did_in_chunk, and RETURN.
Referenced by skip_to().
| void FlintPostList::move_to_chunk_containing | ( | Xapian::docid | desired_did | ) | [private] |
Move to chunk containing the specified document ID.
This moves to the chunk whose starting document ID is <= desired_did, but such that the next chunk's starting document ID is > desired_did.
It is thus possible that current_chunk_contains(desired_did) will return false after this call, since the document ID might lie after the end of this chunk, but before the start of the next chunk.
Definition at line 803 of file flint_postlist.cc.
References Assert, check_tname_in_key_lite(), cursor, DEBUGCALL, did, doclength, end, first_did_in_chunk, is_at_end, is_last_chunk, last_did_in_chunk, FlintPostListTable::make_key(), next_chunk(), number_of_entries, pos, read_start_of_chunk(), read_start_of_first_chunk(), read_wdf_and_length(), report_read_error(), tname, unpack_uint_preserving_sort(), and wdf.
Referenced by skip_to().
| bool FlintPostList::move_forward_in_chunk_to_at_least | ( | Xapian::docid | desired_did | ) | [private] |
Scan forward in the current chunk for the specified document ID.
This is particularly efficient if the desired document ID is greater than the last in the chunk - it then skips straight to the end.
Definition at line 852 of file flint_postlist.cc.
References DEBUGCALL, did, end, last_did_in_chunk, next_in_chunk(), pos, and RETURN.
Referenced by skip_to().
| Xapian::doccount FlintPostList::get_termfreq | ( | ) | const [inline, virtual] |
Returns number of docs indexed by this term.
This is the length of the postlist.
Implements LeafPostList.
Reimplemented in FlintModifiedPostList.
Definition at line 219 of file flint_postlist.h.
References number_of_entries.
| Xapian::docid FlintPostList::get_docid | ( | ) | const [inline, virtual] |
Returns the current docid.
Implements Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 222 of file flint_postlist.h.
References Assert, did, and have_started.
Referenced by FlintModifiedPostList::get_docid(), FlintModifiedPostList::get_doclength(), FlintModifiedPostList::get_wdf(), FlintModifiedPostList::next(), FlintModifiedPostList::open_position_list(), FlintModifiedPostList::read_position_list(), and FlintModifiedPostList::skip_deletes().
| Xapian::doclength FlintPostList::get_doclength | ( | ) | const [inline, virtual] |
Returns the length of current document.
Implements Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 225 of file flint_postlist.h.
References Assert, DEBUGCALL, doclength, have_started, and RETURN.
Referenced by FlintModifiedPostList::get_doclength().
| Xapian::termcount FlintPostList::get_wdf | ( | ) | const [inline, virtual] |
Returns the Within Document Frequency of the term in the current document.
Reimplemented from Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 234 of file flint_postlist.h.
References Assert, have_started, and wdf.
Referenced by FlintModifiedPostList::get_wdf().
| PositionList * FlintPostList::read_position_list | ( | ) | [virtual] |
Get the list of positions of the term in the current document.
Reimplemented from Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 757 of file flint_postlist.cc.
References DEBUGCALL, did, positionlist, FlintPositionList::read_data(), RETURN, this_db, and tname.
Referenced by FlintModifiedPostList::read_position_list().
| PositionList * FlintPostList::open_position_list | ( | ) | const [virtual] |
Get the list of positions of the term in the current document.
Reimplemented from Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 765 of file flint_postlist.cc.
References DEBUGCALL, did, RETURN, this_db, and tname.
Referenced by FlintModifiedPostList::open_position_list().
| PostList * FlintPostList::next | ( | Xapian::weight | w_min | ) | [virtual] |
Move to the next document.
Implements Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 772 of file flint_postlist.cc.
References DEBUGCALL, DEBUGLINE, did, doclength, have_started, is_at_end, next_chunk(), next_in_chunk(), om_tostring(), RETURN, and wdf.
| PostList * FlintPostList::skip_to | ( | Xapian::docid | desired_did, | |
| Xapian::weight | w_min | |||
| ) | [virtual] |
Skip to next document with docid >= docid.
Implements Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 870 of file flint_postlist.cc.
References Assert, current_chunk_contains(), DEBUGCALL, DEBUGLINE, did, doclength, have_started, is_at_end, move_forward_in_chunk_to_at_least(), move_to_chunk_containing(), om_tostring(), RETURN, and wdf.
Referenced by FlintModifiedPostList::skip_to().
| bool FlintPostList::at_end | ( | ) | const [inline, virtual] |
Return true if and only if we're off the end of the list.
Implements Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 251 of file flint_postlist.h.
References is_at_end.
Referenced by FlintModifiedPostList::at_end(), FlintModifiedPostList::get_docid(), FlintModifiedPostList::get_doclength(), FlintModifiedPostList::get_wdf(), FlintModifiedPostList::next(), FlintModifiedPostList::open_position_list(), FlintModifiedPostList::read_position_list(), FlintModifiedPostList::skip_deletes(), and FlintModifiedPostList::skip_to().
| string FlintPostList::get_description | ( | ) | const [virtual] |
Get a description of the document.
Implements Xapian::PostingIterator::Internal.
Reimplemented in FlintModifiedPostList.
Definition at line 907 of file flint_postlist.cc.
References number_of_entries, om_tostring(), and tname.
Referenced by FlintModifiedPostList::get_description().
| void FlintPostList::read_number_of_entries | ( | const char ** | posptr, | |
| const char * | end, | |||
| Xapian::termcount * | number_of_entries_ptr, | |||
| Xapian::termcount * | collection_freq_ptr | |||
| ) | [static] |
Read the number of entries and the collection frequency.
This must only be called when *posptr is pointing to the start of the first chunk of the posting list.
Definition at line 626 of file flint_postlist.cc.
References report_read_error(), and unpack_uint().
Referenced by read_start_of_first_chunk(), and FlintAllTermsList::read_termfreq_and_collfreq().
Xapian::Internal::RefCntPtr<const FlintDatabase> FlintPostList::this_db [protected] |
The database we are searching.
This pointer is held so that the database doesn't get deleted before us, and also to give us access to the position_table.
Definition at line 111 of file flint_postlist.h.
Referenced by FlintModifiedPostList::get_doclength(), FlintModifiedPostList::get_termfreq(), open_position_list(), FlintModifiedPostList::open_position_list(), read_position_list(), and FlintModifiedPostList::read_position_list().
string FlintPostList::tname [protected] |
The termname for this postlist.
Definition at line 114 of file flint_postlist.h.
Referenced by FlintPostList(), get_description(), FlintModifiedPostList::get_termfreq(), move_to_chunk_containing(), next_chunk(), open_position_list(), FlintModifiedPostList::open_position_list(), read_position_list(), and FlintModifiedPostList::read_position_list().
bool FlintPostList::have_started [protected] |
Whether we've started reading the list yet.
Definition at line 117 of file flint_postlist.h.
Referenced by get_docid(), get_doclength(), get_wdf(), next(), FlintModifiedPostList::next(), and skip_to().
FlintPositionList FlintPostList::positionlist [protected] |
The position list object for this posting list.
Definition at line 120 of file flint_postlist.h.
Referenced by read_position_list().
AutoPtr<FlintCursor> FlintPostList::cursor [private] |
Cursor pointing to current chunk of postlist.
Definition at line 124 of file flint_postlist.h.
Referenced by FlintPostList(), move_to_chunk_containing(), and next_chunk().
bool FlintPostList::is_last_chunk [private] |
True if this is the last chunk.
Definition at line 127 of file flint_postlist.h.
Referenced by FlintPostList(), move_to_chunk_containing(), and next_chunk().
The first document id in this chunk.
Definition at line 130 of file flint_postlist.h.
Referenced by current_chunk_contains(), FlintPostList(), move_to_chunk_containing(), and next_chunk().
The last document id in this chunk.
Definition at line 133 of file flint_postlist.h.
Referenced by current_chunk_contains(), FlintPostList(), move_forward_in_chunk_to_at_least(), move_to_chunk_containing(), next_chunk(), and next_in_chunk().
const char* FlintPostList::pos [private] |
Position of iteration through current chunk.
Definition at line 136 of file flint_postlist.h.
Referenced by FlintPostList(), move_forward_in_chunk_to_at_least(), move_to_chunk_containing(), next_chunk(), and next_in_chunk().
const char* FlintPostList::end [private] |
Pointer to byte after end of current chunk.
Definition at line 139 of file flint_postlist.h.
Referenced by FlintPostList(), move_forward_in_chunk_to_at_least(), move_to_chunk_containing(), next_chunk(), and next_in_chunk().
Xapian::docid FlintPostList::did [private] |
Document id we're currently at.
Definition at line 142 of file flint_postlist.h.
Referenced by FlintPostList(), get_docid(), move_forward_in_chunk_to_at_least(), move_to_chunk_containing(), next(), next_chunk(), next_in_chunk(), open_position_list(), read_position_list(), and skip_to().
flint_doclen_t FlintPostList::doclength [private] |
The (absolute) length of the current document.
Definition at line 145 of file flint_postlist.h.
Referenced by FlintPostList(), get_doclength(), move_to_chunk_containing(), next(), next_chunk(), next_in_chunk(), and skip_to().
Xapian::termcount FlintPostList::wdf [private] |
The wdf of the current document.
Definition at line 148 of file flint_postlist.h.
Referenced by FlintPostList(), get_wdf(), move_to_chunk_containing(), next(), next_chunk(), next_in_chunk(), and skip_to().
bool FlintPostList::is_at_end [private] |
Whether we've run off the end of the list yet.
Definition at line 151 of file flint_postlist.h.
Referenced by at_end(), FlintPostList(), move_to_chunk_containing(), next(), next_chunk(), and skip_to().
The number of entries in the posting list.
Definition at line 154 of file flint_postlist.h.
Referenced by FlintPostList(), get_description(), get_termfreq(), and move_to_chunk_containing().