Class FieldInvertState

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.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk

Inheritance

System.Object

FieldInvertState

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public sealed class FieldInvertState : object

Constructors

| Improve this Doc View Source

FieldInvertState(String)

Creates FieldInvertState for the specified field name.

Declaration

public FieldInvertState(string name)

Parameters

Type	Name	Description
System.String	name

| Improve this Doc View Source

FieldInvertState(String, Int32, Int32, Int32, Int32, Single)

Creates FieldInvertState for the specified field name and values for all fields.

Declaration

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

Parameters

Type	Name	Description
System.String	name
System.Int32	position
System.Int32	length
System.Int32	numOverlap
System.Int32	offset
System.Single	boost

Properties

| Improve this Doc View Source

AttributeSource

Gets the AttributeSource from the TokenStream that provided the indexed tokens for this field.

Declaration

public AttributeSource AttributeSource { get; }

Property Value

Type	Description
AttributeSource

| Improve this Doc View Source

Boost

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

Declaration

public float Boost { get; set; }

Property Value

Type	Description
System.Single	the boost

| Improve this Doc View Source

Length

Gets or Sets total number of terms in this field.

Declaration

public int Length { get; set; }

Property Value

Type	Description
System.Int32	the length

| Improve this Doc View Source

MaxTermFrequency

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.

Declaration

public int MaxTermFrequency { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Name

Gets the field's name

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

NumOverlap

Gets or Sets the number of terms with positionIncrement == 0.

Declaration

public int NumOverlap { get; set; }

Property Value

Type	Description
System.Int32	the numOverlap

| Improve this Doc View Source

Offset

Gets end offset of the last processed term.

Declaration

public int Offset { get; }

Property Value

Type	Description
System.Int32	the offset

| Improve this Doc View Source

Position

Gets the last processed term position.

Declaration

public int Position { get; }

Property Value

Type	Description
System.Int32	the position

| Improve this Doc View Source

UniqueTermCount

Gets the number of unique terms encountered in this field.

Declaration

public int UniqueTermCount { get; }

Property Value

Type	Description
System.Int32