Lucene.Net.Index.FieldInvertState Class Reference

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...

Public Member Functions
	FieldInvertState ()
	FieldInvertState (int position, int length, int numOverlap, int offset, float boost)

Properties
int	Position [get]
	Get the last processed term position.
int	Length [get]
	Get total number of terms in this field.
int	NumOverlap [get]
	Get the number of terms with positionIncrement == 0.
int	Offset [get]
	Get end offset of the last processed term.
float	Boost [get]
	Get boost value. This is the cumulative product of document boost and field boost for all field instances sharing the same field name.
AttributeSource	AttributeSource [get]

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.

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

Definition at line 32 of file FieldInvertState.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.FieldInvertState.FieldInvertState

(

)

Definition at line 41 of file FieldInvertState.cs.

Lucene.Net.Index.FieldInvertState.FieldInvertState	(	int	position,
		int	length,
		int	numOverlap,
		int	offset,
		float	boost
	)

Definition at line 45 of file FieldInvertState.cs.

Property Documentation

AttributeSource Lucene.Net.Index.FieldInvertState.AttributeSource

get

Definition at line 106 of file FieldInvertState.cs.

float Lucene.Net.Index.FieldInvertState.Boost

get

Get boost value. This is the cumulative product of document boost and field boost for all field instances sharing the same field name.

the boost

Definition at line 101 of file FieldInvertState.cs.

int Lucene.Net.Index.FieldInvertState.Length

get

Get total number of terms in this field.

the length

Definition at line 77 of file FieldInvertState.cs.

int Lucene.Net.Index.FieldInvertState.NumOverlap

get

Get the number of terms with positionIncrement == 0.

the numOverlap

Definition at line 84 of file FieldInvertState.cs.

int Lucene.Net.Index.FieldInvertState.Offset

get

Get end offset of the last processed term.

the offset

Definition at line 91 of file FieldInvertState.cs.

int Lucene.Net.Index.FieldInvertState.Position

get

Get the last processed term position.

the position

Definition at line 70 of file FieldInvertState.cs.

---

The documentation for this class was generated from the following file:

• core/Index/FieldInvertState.cs