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>
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 |
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
-
docBoost | boost value to use. |
boost::shared_ptr< FieldInvertState > Lucene::FieldInvertState::shared_from_this |
( |
| ) |
|
|
inline |
Field Documentation
INTERNAL Lucene::FieldInvertState::__pad0__ |
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: