Lucene++ - a full-featured, c++ search engine
API Documentation
Public for extension only. More...
#include <TermSpans.h>
Public Member Functions | |
TermSpans (TermPositionsPtr positions, TermPtr term) | |
virtual | ~TermSpans () |
virtual String | getClassName () |
boost::shared_ptr< TermSpans > | shared_from_this () |
virtual bool | next () |
Move to the next match, returning true if any such exists. More... | |
virtual bool | skipTo (int32_t target) |
Skips to the first match beyond the current, whose document number is greater than or equal to target. More... | |
virtual int32_t | doc () |
Returns the document number of the current match. Initially invalid. More... | |
virtual int32_t | start () |
Returns the start position of the current match. Initially invalid. More... | |
virtual int32_t | end () |
Returns the end position of the current match. Initially invalid. More... | |
virtual Collection< ByteArray > | getPayload () |
Returns the payload data for the current span. This is invalid until next() is called for the first time. This method must not be called more than once after each call of next(). However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option. More... | |
virtual bool | isPayloadAvailable () |
Checks if a payload can be loaded at this position. More... | |
virtual String | toString () |
Returns a string representation of the object. More... | |
TermPositionsPtr | getPositions () |
![]() | |
virtual | ~Spans () |
boost::shared_ptr< Spans > | shared_from_this () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. More... | |
virtual LuceneObjectPtr | clone (LuceneObjectPtr other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
virtual bool | equals (LuceneObjectPtr other) |
Return whether two objects are equal. More... | |
virtual int32_t | compareTo (LuceneObjectPtr other) |
Compare two objects. More... | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. More... | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. More... | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. More... | |
virtual void | unlock () |
Unlock this object. More... | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. More... | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. More... | |
virtual void | notifyAll () |
Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Protected Attributes | |
TermPositionsPtr | positions |
TermPtr | term |
int32_t | _doc |
int32_t | freq |
int32_t | count |
int32_t | position |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
Public for extension only.
Lucene::TermSpans::TermSpans | ( | TermPositionsPtr | positions, |
TermPtr | term | ||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Returns the document number of the current match. Initially invalid.
Implements Lucene::Spans.
|
virtual |
Returns the end position of the current match. Initially invalid.
Implements Lucene::Spans.
|
inlinevirtual |
Reimplemented from Lucene::Spans.
|
virtual |
Returns the payload data for the current span. This is invalid until next() is called for the first time. This method must not be called more than once after each call of next(). However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.
Note that the return type is a collection, thus the ordering should not be relied upon.
Implements Lucene::Spans.
TermPositionsPtr Lucene::TermSpans::getPositions | ( | ) |
|
virtual |
Checks if a payload can be loaded at this position.
Payloads can only be loaded once per call to next().
Implements Lucene::Spans.
|
virtual |
Move to the next match, returning true if any such exists.
Implements Lucene::Spans.
|
inline |
|
virtual |
Skips to the first match beyond the current, whose document number is greater than or equal to target.
Returns true if there is such a match.
Behaves as if written:
bool skipTo(int32_t target) { do { if (!next()) return false; } while (target > doc()); return true; }
Most implementations are considerably more efficient than that.
Implements Lucene::Spans.
|
virtual |
Returns the start position of the current match. Initially invalid.
Implements Lucene::Spans.
|
virtual |
Returns a string representation of the object.
Reimplemented from Lucene::LuceneObject.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |