Class Fields

Flex API for access to fields and terms

Note

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

Inheritance
object
Fields
FieldsProducer
FilterAtomicReader.FilterFields
MultiFields
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class Fields : IEnumerable<string>, IEnumerable

Constructors

Fields()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration
protected Fields()

Fields

EMPTY_ARRAY

Zero-length Fields array.

Declaration
public static readonly Fields[] EMPTY_ARRAY
Field Value
Type Description
Fields[]

Properties

Count

Gets the number of fields or -1 if the number of distinct field names is unknown. If >= 0, GetEnumerator() will return as many field names.

NOTE: This was size() in Lucene.
Declaration
public abstract int Count { get; }
Property Value
Type Description
int

UniqueTermCount

Returns the number of terms for all fields, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

Declaration
[Obsolete("Iterate fields and add their Count instead. This method is only provided as a transition mechanism to access this statistic for 3.x indexes, which do not have this statistic per-field.")]
public virtual long UniqueTermCount { get; }
Property Value
Type Description
long
See Also

Methods

GetEnumerator()

Returns an enumerator that will step through all field names. This will not return null.

Declaration
public abstract IEnumerator<string> GetEnumerator()
Returns
Type Description
IEnumerator<string>

GetTerms(string)

Get the Terms for this field. This will return null if the field does not exist.

Declaration
public abstract Terms GetTerms(string field)
Parameters
Type Name Description
string field
Returns
Type Description
Terms

Implements