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.

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 getMaxTermFrequency()
Get the maximum term-frequency encountered for any term in the 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.
void setBoost(float boost)
void setLength(int length)
void setNumOverlap(int numOverlap)
[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 getMaxTermFrequency ()

Get the maximum term-frequency encountered for any term in the field. A field containing "the quick brown fox jumps over the lazy dog" would have a value of 2, because "the" appears twice.

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

public void setBoost (float boost)

public void setLength (int length)

public void setNumOverlap (int numOverlap)