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.
Implements
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class Fields : IEnumerable<string>, IEnumerable
Constructors
| Improve this Doc View SourceFields()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Declaration
protected Fields()
Fields
| Improve this Doc View SourceEMPTY_ARRAY
Zero-length Fields array.
Declaration
public static readonly Fields[] EMPTY_ARRAY
Field Value
Type | Description |
---|---|
Fields[] |
Properties
| Improve this Doc View SourceCount
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 |
---|---|
System.Int32 |
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 |
---|---|
System.Int64 |
See Also
Methods
| Improve this Doc View SourceGetEnumerator()
Returns an enumerator that will step through all field
names. This will not return null
.
Declaration
public abstract IEnumerator<string> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<System.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 |
---|---|---|
System.String | field |
Returns
Type | Description |
---|---|
Terms |
Explicit Interface Implementations
| Improve this Doc View SourceIEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator |