Class FieldInfos

Collection of FieldInfos (accessible by number or by name).

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

FieldInfos

Implements

IEnumerable<FieldInfo>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public class FieldInfos : IEnumerable<FieldInfo>, IEnumerable

Constructors

FieldInfos(FieldInfo[])

Constructs a new FieldInfos from an array of FieldInfo objects

Declaration

public FieldInfos(FieldInfo[] infos)

Parameters

Type	Name	Description
FieldInfo[]	infos

Properties

Count

Returns the number of fields.

NOTE: This was size() in Lucene.

Declaration

public virtual int Count { get; }

Property Value

Type	Description
int

HasDocValues

Returns true if any fields have DocValues

Declaration

public virtual bool HasDocValues { get; }

Property Value

Type	Description
bool

HasFreq

Returns true if any fields have freqs

Declaration

public virtual bool HasFreq { get; }

Property Value

Type	Description
bool

HasNorms

Returns true if any fields have norms

Declaration

public virtual bool HasNorms { get; }

Property Value

Type	Description
bool

HasOffsets

Returns true if any fields have offsets

Declaration

public virtual bool HasOffsets { get; }

Property Value

Type	Description
bool

HasPayloads

Returns true if any fields have payloads

Declaration

public virtual bool HasPayloads { get; }

Property Value

Type	Description
bool

HasProx

Returns true if any fields have positions

Declaration

public virtual bool HasProx { get; }

Property Value

Type	Description
bool

HasVectors

Returns true if any fields have vectors

Declaration

public virtual bool HasVectors { get; }

Property Value

Type	Description
bool

Methods

FieldInfo(int)

Return the FieldInfo object referenced by the fieldNumber.

Declaration

public virtual FieldInfo FieldInfo(int fieldNumber)

Parameters

Type	Name	Description
int	fieldNumber	field's number.

Returns

Type	Description
FieldInfo	the FieldInfo object or null when the given fieldNumber doesn't exist.

Exceptions

Type	Condition
ArgumentException	if fieldNumber is negative

FieldInfo(string)

Return the FieldInfo object referenced by the fieldName

Declaration

public virtual FieldInfo FieldInfo(string fieldName)

Parameters

Type	Name	Description
string	fieldName

Returns

Type	Description
FieldInfo	the FieldInfo object or null when the given fieldName doesn't exist.

GetEnumerator()

Returns an iterator over all the fieldinfo objects present, ordered by ascending field number

Declaration

public virtual IEnumerator<FieldInfo> GetEnumerator()

Returns

Type	Description
IEnumerator<FieldInfo>

Implements

IEnumerable<T>

IEnumerable