org.apache.lucene.index
Class FieldInvertState

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

public final class FieldInvertState
extends Object

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 experimental and might change in incompatible ways in the next release.

Constructor Summary

FieldInvertState()

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

Method Summary

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.
int	getUniqueTermCount() Return the number of unique terms encountered in this field.
void	setBoost(float boost)
void	setLength(int length)
void	setNumOverlap(int numOverlap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldInvertState

public FieldInvertState()

FieldInvertState

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

Method Detail

getPosition

public int getPosition()

Get the last processed term position.

Returns:

the position

getLength

public int getLength()

Get total number of terms in this field.

Returns:

the length

setLength

public void setLength(int length)

getNumOverlap

public int getNumOverlap()

Get the number of terms with positionIncrement == 0.

Returns:

the numOverlap

setNumOverlap

public void setNumOverlap(int numOverlap)

getOffset

public int getOffset()

Get end offset of the last processed term.

Returns:

the offset

getBoost

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

setBoost

public void setBoost(float boost)

getMaxTermFrequency

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.

getUniqueTermCount

public int getUniqueTermCount()

Return the number of unique terms encountered in this field.

getAttributeSource

public AttributeSource getAttributeSource()