public final class

FieldInvertState

extends Object
java.lang.Object
   ↳ org.apache.lucene.index.FieldInvertState

Class Overview

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.

WARNING: This API is new and experimental, and may suddenly change.

Summary

Public Constructors
FieldInvertState()
FieldInvertState(int position, int length, int numOverlap, int offset, float boost)
Public Methods
AttributeSource getAttributeSource()
float getBoost()
Get boost value.
int getLength()
Get total number of terms in this field.
int getNumOverlap()
Get the number of terms with positionIncrement == 0.
int getOffset()
Get end offset of the last processed term.
int getPosition()
Get the last processed term position.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FieldInvertState ()

public FieldInvertState (int position, int length, int numOverlap, int offset, float boost)

Public Methods

public AttributeSource getAttributeSource ()

public float 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

public int getLength ()

Get total number of terms in this field.

Returns
  • the length

public int getNumOverlap ()

Get the number of terms with positionIncrement == 0.

Returns
  • the numOverlap

public int getOffset ()

Get end offset of the last processed term.

Returns
  • the offset

public int getPosition ()

Get the last processed term position.

Returns
  • the position