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


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

#include <SegmentTermEnum.h>

+ Inheritance diagram for Lucene::SegmentTermEnum:

Public Member Functions

 SegmentTermEnum ()
 
 SegmentTermEnum (const IndexInputPtr &i, const FieldInfosPtr &fis, bool isi)
 
virtual ~SegmentTermEnum ()
 
virtual String getClassName ()
 
boost::shared_ptr< SegmentTermEnumshared_from_this ()
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
void seek (int64_t pointer, int64_t p, const TermPtr &t, const TermInfoPtr &ti)
 
virtual bool next ()
 Increments the enumeration to the next element. True if one exists.
 
int32_t scanTo (const TermPtr &term)
 Optimized scan, without allocating new terms. Return number of invocations to next().
 
virtual TermPtr term ()
 Returns the current Term in the enumeration. Initially invalid, valid after next() called for the first time.
 
TermPtr prev ()
 Returns the previous Term enumerated. Initially null.
 
TermInfoPtr termInfo ()
 Returns the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.
 
void termInfo (const TermInfoPtr &ti)
 Sets the argument to the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.
 
virtual int32_t docFreq ()
 Returns the docFreq of the current Term in the enumeration. Initially invalid, valid after next() called for the first time.
 
int64_t freqPointer ()
 Returns the freqPointer from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.
 
int64_t proxPointer ()
 Returns the proxPointer from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.
 
virtual void close ()
 Closes the enumeration to further activity, freeing resources.
 
- Public Member Functions inherited from Lucene::TermEnum
virtual ~TermEnum ()
 
boost::shared_ptr< TermEnumshared_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 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.
 
- 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::TermEnum
static String _getClassName ()
 

Data Fields

FieldInfosPtr fieldInfos
 
int64_t size
 
int64_t position
 
int64_t indexPointer
 
int32_t indexInterval
 
int32_t skipInterval
 
int32_t maxSkipLevels
 

Protected Attributes

IndexInputPtr input
 
TermBufferPtr termBuffer
 
TermBufferPtr prevBuffer
 
TermBufferPtr scanBuffer
 
TermInfoPtr _termInfo
 
int32_t format
 
bool isIndex
 
int32_t formatM1SkipInterval
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ SegmentTermEnum() [1/2]

Lucene::SegmentTermEnum::SegmentTermEnum ( )

◆ SegmentTermEnum() [2/2]

Lucene::SegmentTermEnum::SegmentTermEnum ( const IndexInputPtr i,
const FieldInfosPtr fis,
bool  isi 
)

◆ ~SegmentTermEnum()

virtual Lucene::SegmentTermEnum::~SegmentTermEnum ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ clone()

virtual LuceneObjectPtr Lucene::SegmentTermEnum::clone ( const LuceneObjectPtr other = LuceneObjectPtr())
virtual

Return clone of this object.

Parameters
otherclone reference - null when called initially, then set in top virtual override.

Reimplemented from Lucene::LuceneObject.

◆ close()

virtual void Lucene::SegmentTermEnum::close ( )
virtual

Closes the enumeration to further activity, freeing resources.

Implements Lucene::TermEnum.

◆ docFreq()

virtual int32_t Lucene::SegmentTermEnum::docFreq ( )
virtual

Returns the docFreq of the current Term in the enumeration. Initially invalid, valid after next() called for the first time.

Implements Lucene::TermEnum.

◆ freqPointer()

int64_t Lucene::SegmentTermEnum::freqPointer ( )

Returns the freqPointer from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.

◆ getClassName()

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

Reimplemented from Lucene::TermEnum.

◆ next()

virtual bool Lucene::SegmentTermEnum::next ( )
virtual

Increments the enumeration to the next element. True if one exists.

Implements Lucene::TermEnum.

◆ prev()

TermPtr Lucene::SegmentTermEnum::prev ( )

Returns the previous Term enumerated. Initially null.

◆ proxPointer()

int64_t Lucene::SegmentTermEnum::proxPointer ( )

Returns the proxPointer from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.

◆ scanTo()

int32_t Lucene::SegmentTermEnum::scanTo ( const TermPtr term)

Optimized scan, without allocating new terms. Return number of invocations to next().

◆ seek()

void Lucene::SegmentTermEnum::seek ( int64_t  pointer,
int64_t  p,
const TermPtr t,
const TermInfoPtr ti 
)

◆ shared_from_this()

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

◆ term()

virtual TermPtr Lucene::SegmentTermEnum::term ( )
virtual

Returns the current Term in the enumeration. Initially invalid, valid after next() called for the first time.

Implements Lucene::TermEnum.

◆ termInfo() [1/2]

TermInfoPtr Lucene::SegmentTermEnum::termInfo ( )

Returns the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.

◆ termInfo() [2/2]

void Lucene::SegmentTermEnum::termInfo ( const TermInfoPtr ti)

Sets the argument to the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.

Field Documentation

◆ _termInfo

TermInfoPtr Lucene::SegmentTermEnum::_termInfo
protected

◆ fieldInfos

FieldInfosPtr Lucene::SegmentTermEnum::fieldInfos

◆ format

int32_t Lucene::SegmentTermEnum::format
protected

◆ formatM1SkipInterval

int32_t Lucene::SegmentTermEnum::formatM1SkipInterval
protected

◆ indexInterval

int32_t Lucene::SegmentTermEnum::indexInterval

◆ indexPointer

int64_t Lucene::SegmentTermEnum::indexPointer

◆ input

IndexInputPtr Lucene::SegmentTermEnum::input
protected

◆ isIndex

bool Lucene::SegmentTermEnum::isIndex
protected

◆ maxSkipLevels

int32_t Lucene::SegmentTermEnum::maxSkipLevels

◆ position

int64_t Lucene::SegmentTermEnum::position

◆ prevBuffer

TermBufferPtr Lucene::SegmentTermEnum::prevBuffer
protected

◆ scanBuffer

TermBufferPtr Lucene::SegmentTermEnum::scanBuffer
protected

◆ size

int64_t Lucene::SegmentTermEnum::size

◆ skipInterval

int32_t Lucene::SegmentTermEnum::skipInterval

◆ termBuffer

TermBufferPtr Lucene::SegmentTermEnum::termBuffer
protected

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

clucene.sourceforge.net