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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::FieldInvertState Class Reference

This class tracks the number and position / offset parameters of terms being added to the index. The information collected in this class is also used to calculate the normalization factor for a field. More...

#include <FieldInvertState.h>

+ Inheritance diagram for Lucene::FieldInvertState:

Public Member Functions

 FieldInvertState (int32_t position=0, int32_t length=0, int32_t numOverlap=0, int32_t offset=0, double boost=0)
virtual ~FieldInvertState ()
virtual String getClassName ()
boost::shared_ptr
< FieldInvertState
shared_from_this ()
void reset (double docBoost)
 Re-initialize the state, using this boost value.
int32_t getPosition ()
 Get the last processed term position.
int32_t getLength ()
 Get total number of terms in this field.
int32_t getNumOverlap ()
 Get the number of terms with positionIncrement == 0.
int32_t getOffset ()
 Get end offset of the last processed term.
double getBoost ()
 Get boost value. This is the cumulative product of document boost and field boost for all field instances sharing the same field name.
AttributeSourcePtr getAttributeSource ()
- 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.
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 ()

Data Fields

INTERNAL __pad0__: int32_t position
int32_t length
int32_t numOverlap
int32_t offset
double boost
AttributeSourcePtr attributeSource

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
LuceneSignalPtr objectSignal

Detailed Description

This class tracks the number and position / offset parameters of terms being added to the index. The information collected in this class is also used to calculate the normalization factor for a field.

Constructor & Destructor Documentation

Lucene::FieldInvertState::FieldInvertState ( int32_t  position = 0,
int32_t  length = 0,
int32_t  numOverlap = 0,
int32_t  offset = 0,
double  boost = 0 
)
virtual Lucene::FieldInvertState::~FieldInvertState ( )
virtual

Member Function Documentation

static String Lucene::FieldInvertState::_getClassName ( )
inlinestatic
AttributeSourcePtr Lucene::FieldInvertState::getAttributeSource ( )
double Lucene::FieldInvertState::getBoost ( )

Get boost value. This is the cumulative product of document boost and field boost for all field instances sharing the same field name.

Returns
the boost
virtual String Lucene::FieldInvertState::getClassName ( )
inlinevirtual
int32_t Lucene::FieldInvertState::getLength ( )

Get total number of terms in this field.

Returns
the length
int32_t Lucene::FieldInvertState::getNumOverlap ( )

Get the number of terms with positionIncrement == 0.

Returns
the numOverlap
int32_t Lucene::FieldInvertState::getOffset ( )

Get end offset of the last processed term.

Returns
the offset
int32_t Lucene::FieldInvertState::getPosition ( )

Get the last processed term position.

Returns
the position
void Lucene::FieldInvertState::reset ( double  docBoost)

Re-initialize the state, using this boost value.

Parameters
docBoostboost value to use.
boost::shared_ptr< FieldInvertState > Lucene::FieldInvertState::shared_from_this ( )
inline

Field Documentation

INTERNAL Lucene::FieldInvertState::__pad0__
AttributeSourcePtr Lucene::FieldInvertState::attributeSource
double Lucene::FieldInvertState::boost
int32_t Lucene::FieldInvertState::length
int32_t Lucene::FieldInvertState::numOverlap
int32_t Lucene::FieldInvertState::offset

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

clucene.sourceforge.net