Class FSTTermsReader

FST-based terms dictionary reader.

The FST directly maps each term and its metadata, it is memory resident.

Note

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

Inheritance
object
Fields
FieldsProducer
FSTTermsReader
Inherited Members
FieldsProducer.Dispose()
Fields.UniqueTermCount
Fields.EMPTY_ARRAY
Namespace: Lucene.Net.Codecs.Memory
Assembly: Lucene.Net.Codecs.dll
Syntax
public class FSTTermsReader : FieldsProducer, IEnumerable<string>, IEnumerable, IDisposable

Constructors

FSTTermsReader(SegmentReadState, PostingsReaderBase)

FST-based terms dictionary reader.

The FST directly maps each term and its metadata, it is memory resident.

Note

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

Declaration
public FSTTermsReader(SegmentReadState state, PostingsReaderBase postingsReader)
Parameters
Type Name Description
SegmentReadState state
PostingsReaderBase postingsReader

Properties

Count

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

NOTE: This was size() in Lucene.
Declaration
public override int Count { get; }
Property Value
Type Description
int
Overrides
Lucene.Net.Index.Fields.Count

Methods

CheckIntegrity()

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration
public override void CheckIntegrity()
Overrides
Lucene.Net.Codecs.FieldsProducer.CheckIntegrity()

Dispose(bool)

Implementations must override and should dispose all resources used by this instance.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

GetEnumerator()

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

Declaration
public override IEnumerator<string> GetEnumerator()
Returns
Type Description
IEnumerator<string>
Overrides
Lucene.Net.Index.Fields.GetEnumerator()

GetTerms(string)

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

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

RamBytesUsed()

Returns approximate RAM bytes used.

Declaration
public override long RamBytesUsed()
Returns
Type Description
long
Overrides
Lucene.Net.Codecs.FieldsProducer.RamBytesUsed()

Implements