Lucene++ - a full-featured, c++ search engine
API Documentation
Implements the skip list reader for the default posting list format that stores positions and payloads. More...
#include <DefaultSkipListReader.h>
Public Member Functions | |
DefaultSkipListReader (const IndexInputPtr &skipStream, int32_t maxSkipLevels, int32_t skipInterval) | |
virtual | ~DefaultSkipListReader () |
virtual String | getClassName () |
boost::shared_ptr< DefaultSkipListReader > | shared_from_this () |
void | init (int64_t skipPointer, int64_t freqBasePointer, int64_t proxBasePointer, int32_t df, bool storesPayloads) |
int64_t | getFreqPointer () |
Returns the freq pointer of the doc to which the last call of MultiLevelSkipListReader#skipTo(int) has skipped. | |
int64_t | getProxPointer () |
Returns the prox pointer of the doc to which the last call of MultiLevelSkipListReader#skipTo(int) has skipped. | |
int32_t | getPayloadLength () |
Returns the payload length of the payload stored just before the doc to which the last call of MultiLevelSkipListReader#skipTo(int) has skipped. | |
![]() | |
MultiLevelSkipListReader (const IndexInputPtr &skipStream, int32_t maxSkipLevels, int32_t skipInterval) | |
virtual | ~MultiLevelSkipListReader () |
boost::shared_ptr< MultiLevelSkipListReader > | shared_from_this () |
virtual int32_t | getDoc () |
Returns the id of the doc to which the last call of skipTo(int) has skipped. | |
virtual int32_t | skipTo (int32_t target) |
Skips entries to the first beyond the current whose document number is greater than or equal to target. Returns the current doc count. | |
virtual void | close () |
virtual void | init (int64_t skipPointer, int32_t df) |
Initializes the reader. | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Protected Member Functions | |
virtual void | seekChild (int32_t level) |
Seeks the skip entry on the given level. | |
virtual void | setLastSkipData (int32_t level) |
Copies the values of the last read skip entry on this level. | |
virtual int32_t | readSkipData (int32_t level, const IndexInputPtr &skipStream) |
Subclasses must implement the actual skip data encoding in this method. | |
![]() | |
virtual bool | loadNextSkip (int32_t level) |
virtual void | loadSkipLevels () |
Loads the skip levels. | |
![]() | |
LuceneObject () | |
Protected Attributes | |
bool | currentFieldStoresPayloads |
Collection< int64_t > | freqPointer |
Collection< int64_t > | proxPointer |
Collection< int32_t > | payloadLength |
int64_t | lastFreqPointer |
int64_t | lastProxPointer |
int32_t | lastPayloadLength |
![]() | |
int32_t | maxNumberOfSkipLevels |
the maximum number of skip levels possible for this index | |
int32_t | numberOfSkipLevels |
number of levels in this skip list | |
int32_t | numberOfLevelsToBuffer |
Defines the number of top skip levels to buffer in memory. Reducing this number results in less memory usage, but possibly slower performance due to more random I/Os. Please notice that the space each level occupies is limited by the skipInterval. The top level can not contain more than skipLevel entries, the second top level can not contain more than skipLevel^2 entries and so forth. | |
int32_t | docCount |
bool | haveSkipped |
Collection< IndexInputPtr > | skipStream |
Collection< int64_t > | skipPointer |
Collection< int32_t > | skipInterval |
Collection< int32_t > | numSkipped |
Collection< int32_t > | skipDoc |
int32_t | lastDoc |
Collection< int64_t > | childPointer |
int64_t | lastChildPointer |
bool | inputIsBuffered |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Implements the skip list reader for the default posting list format that stores positions and payloads.
Lucene::DefaultSkipListReader::DefaultSkipListReader | ( | const IndexInputPtr & | skipStream, |
int32_t | maxSkipLevels, | ||
int32_t | skipInterval | ||
) |
|
virtual |
|
inlinestatic |
|
inlinevirtual |
Reimplemented from Lucene::MultiLevelSkipListReader.
int64_t Lucene::DefaultSkipListReader::getFreqPointer | ( | ) |
Returns the freq pointer of the doc to which the last call of MultiLevelSkipListReader#skipTo(int)
has skipped.
int32_t Lucene::DefaultSkipListReader::getPayloadLength | ( | ) |
Returns the payload length of the payload stored just before the doc to which the last call of MultiLevelSkipListReader#skipTo(int)
has skipped.
int64_t Lucene::DefaultSkipListReader::getProxPointer | ( | ) |
Returns the prox pointer of the doc to which the last call of MultiLevelSkipListReader#skipTo(int)
has skipped.
void Lucene::DefaultSkipListReader::init | ( | int64_t | skipPointer, |
int64_t | freqBasePointer, | ||
int64_t | proxBasePointer, | ||
int32_t | df, | ||
bool | storesPayloads | ||
) |
|
protectedvirtual |
Subclasses must implement the actual skip data encoding in this method.
Implements Lucene::MultiLevelSkipListReader.
|
protectedvirtual |
Seeks the skip entry on the given level.
Reimplemented from Lucene::MultiLevelSkipListReader.
|
protectedvirtual |
Copies the values of the last read skip entry on this level.
Reimplemented from Lucene::MultiLevelSkipListReader.
|
inline |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |