Lucene++ - a full-featured, c++ search engine
API Documentation
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>
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. More... | |
int32_t | getPosition () |
Get the last processed term position. More... | |
int32_t | getLength () |
Get total number of terms in this field. More... | |
int32_t | getNumOverlap () |
Get the number of terms with positionIncrement == 0. More... | |
int32_t | getOffset () |
Get end offset of the last processed term. More... | |
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. More... | |
AttributeSourcePtr | getAttributeSource () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. More... | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. More... | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. More... | |
virtual String | toString () |
Returns a string representation of the object. 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 () |
Data Fields | |
INTERNAL | __pad0__: int32_t position |
int32_t | length |
int32_t | numOverlap |
int32_t | offset |
double | boost |
AttributeSourcePtr | attributeSource |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
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.
Lucene::FieldInvertState::FieldInvertState | ( | int32_t | position = 0 , |
int32_t | length = 0 , |
||
int32_t | numOverlap = 0 , |
||
int32_t | offset = 0 , |
||
double | boost = 0 |
||
) |
|
virtual |
|
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.
|
inlinevirtual |
int32_t Lucene::FieldInvertState::getLength | ( | ) |
Get total number of terms in this field.
int32_t Lucene::FieldInvertState::getNumOverlap | ( | ) |
Get the number of terms with positionIncrement == 0.
int32_t Lucene::FieldInvertState::getOffset | ( | ) |
Get end offset of the last processed term.
int32_t Lucene::FieldInvertState::getPosition | ( | ) |
Get the last processed term position.
void Lucene::FieldInvertState::reset | ( | double | docBoost | ) |
Re-initialize the state, using this boost value.
docBoost | boost value to use. |
|
inline |
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 |