Class VariableGapTermsIndexWriter

Selects index terms according to provided pluggable VariableGapTermsIndexWriter.IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an Lucene.Net.Util.Fst.FST<T>. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).

Note

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

Inheritance

object

TermsIndexWriterBase

VariableGapTermsIndexWriter

Implements

IDisposable

Inherited Members

TermsIndexWriterBase.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs.BlockTerms

Assembly: Lucene.Net.Codecs.dll

Syntax

public class VariableGapTermsIndexWriter : TermsIndexWriterBase, IDisposable

Constructors

VariableGapTermsIndexWriter(SegmentWriteState, IndexTermSelector)

Selects index terms according to provided pluggable VariableGapTermsIndexWriter.IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an Lucene.Net.Util.Fst.FST<T>. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).

Note

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

Declaration

public VariableGapTermsIndexWriter(SegmentWriteState state, VariableGapTermsIndexWriter.IndexTermSelector policy)

Parameters

Type	Name	Description
SegmentWriteState	state
VariableGapTermsIndexWriter.IndexTermSelector	policy

Fields

m_output

Selects index terms according to provided pluggable VariableGapTermsIndexWriter.IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an Lucene.Net.Util.Fst.FST<T>. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).

Note

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

Declaration

protected IndexOutput m_output

Field Value

Type	Description
IndexOutput

Methods

AddField(FieldInfo, long)

Selects index terms according to provided pluggable VariableGapTermsIndexWriter.IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an Lucene.Net.Util.Fst.FST<T>. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).

Note

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

Declaration

public override TermsIndexWriterBase.FieldWriter AddField(FieldInfo field, long termsFilePointer)

Parameters

Type	Name	Description
FieldInfo	field
long	termsFilePointer

Returns

Type	Description
TermsIndexWriterBase.FieldWriter

Overrides

TermsIndexWriterBase.AddField(FieldInfo, long)

Dispose(bool)

Selects index terms according to provided pluggable VariableGapTermsIndexWriter.IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an Lucene.Net.Util.Fst.FST<T>. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).

Note

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

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

TermsIndexWriterBase.Dispose(bool)

IndexedTermPrefixLength(BytesRef, BytesRef)

Selects index terms according to provided pluggable VariableGapTermsIndexWriter.IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an Lucene.Net.Util.Fst.FST<T>. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).

Note

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

Declaration

protected virtual int IndexedTermPrefixLength(BytesRef priorTerm, BytesRef indexedTerm)

Parameters

Type	Name	Description
BytesRef	priorTerm
BytesRef	indexedTerm

Returns

Type	Description
int

Remarks

NOTE: If your codec does not sort in unicode code point order, you must override this method to simply return indexedTerm.Length.

Implements

IDisposable