Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::TermSpans Class Reference

Public for extension only. More...

#include <TermSpans.h>

+ Inheritance diagram for Lucene::TermSpans:

Public Member Functions

 TermSpans (const TermPositionsPtr &positions, const TermPtr &term)
 
virtual ~TermSpans ()
 
virtual String getClassName ()
 
boost::shared_ptr< TermSpansshared_from_this ()
 
virtual bool next ()
 Move to the next match, returning true if any such exists.
 
virtual bool skipTo (int32_t target)
 Skips to the first match beyond the current, whose document number is greater than or equal to target.
 
virtual int32_t doc ()
 Returns the document number of the current match. Initially invalid.
 
virtual int32_t start ()
 Returns the start position of the current match. Initially invalid.
 
virtual int32_t end ()
 Returns the end position of the current match. Initially invalid.
 
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.
 
virtual bool isPayloadAvailable ()
 Checks if a payload can be loaded at this position.
 
virtual String toString ()
 Returns a string representation of the object.
 
TermPositionsPtr getPositions ()
 
- Public Member Functions inherited from Lucene::Spans
virtual ~Spans ()
 
boost::shared_ptr< Spansshared_from_this ()
 
- Public Member Functions inherited from Lucene::LuceneObject
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.
 
- Public Member Functions inherited from Lucene::LuceneSync
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 Public Member Functions inherited from Lucene::Spans
static String _getClassName ()
 

Protected Attributes

TermPositionsPtr positions
 
TermPtr term
 
int32_t _doc
 
int32_t freq
 
int32_t count
 
int32_t position
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Detailed Description

Public for extension only.

Constructor & Destructor Documentation

◆ TermSpans()

Lucene::TermSpans::TermSpans ( const TermPositionsPtr positions,
const TermPtr term 
)

◆ ~TermSpans()

virtual Lucene::TermSpans::~TermSpans ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::TermSpans::_getClassName ( )
inlinestatic

◆ doc()

virtual int32_t Lucene::TermSpans::doc ( )
virtual

Returns the document number of the current match. Initially invalid.

Implements Lucene::Spans.

◆ end()

virtual int32_t Lucene::TermSpans::end ( )
virtual

Returns the end position of the current match. Initially invalid.

Implements Lucene::Spans.

◆ getClassName()

virtual String Lucene::TermSpans::getClassName ( )
inlinevirtual

Reimplemented from Lucene::Spans.

◆ getPayload()

virtual Collection< ByteArray > Lucene::TermSpans::getPayload ( )
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.

Returns
a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false

Implements Lucene::Spans.

◆ getPositions()

TermPositionsPtr Lucene::TermSpans::getPositions ( )

◆ isPayloadAvailable()

virtual bool Lucene::TermSpans::isPayloadAvailable ( )
virtual

Checks if a payload can be loaded at this position.

Payloads can only be loaded once per call to next().

Returns
true if there is a payload available at this position that can be loaded

Implements Lucene::Spans.

◆ next()

virtual bool Lucene::TermSpans::next ( )
virtual

Move to the next match, returning true if any such exists.

Implements Lucene::Spans.

◆ shared_from_this()

boost::shared_ptr< TermSpans > Lucene::TermSpans::shared_from_this ( )
inline

◆ skipTo()

virtual bool Lucene::TermSpans::skipTo ( int32_t  target)
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.

◆ start()

virtual int32_t Lucene::TermSpans::start ( )
virtual

Returns the start position of the current match. Initially invalid.

Implements Lucene::Spans.

◆ toString()

virtual String Lucene::TermSpans::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Field Documentation

◆ _doc

int32_t Lucene::TermSpans::_doc
protected

◆ count

int32_t Lucene::TermSpans::count
protected

◆ freq

int32_t Lucene::TermSpans::freq
protected

◆ position

int32_t Lucene::TermSpans::position
protected

◆ positions

TermPositionsPtr Lucene::TermSpans::positions
protected

◆ term

TermPtr Lucene::TermSpans::term
protected

The documentation for this class was generated from the following file:

clucene.sourceforge.net