Class BufferingTermFreqEnumeratorWrapper

This wrapper buffers incoming elements.

Note

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

Inheritance

object

BufferingTermFreqEnumeratorWrapper

Implements

ITermFreqEnumerator

IBytesRefEnumerator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search.Suggest

Assembly: Lucene.Net.Suggest.dll

Syntax

public class BufferingTermFreqEnumeratorWrapper : ITermFreqEnumerator, IBytesRefEnumerator

Constructors

BufferingTermFreqEnumeratorWrapper(ITermFreqEnumerator)

Creates a new iterator, buffering entries from the specified iterator

Declaration

public BufferingTermFreqEnumeratorWrapper(ITermFreqEnumerator source)

Parameters

Type	Name	Description
ITermFreqEnumerator	source

Fields

m_curPos

current buffer position

Declaration

protected int m_curPos

Field Value

Type	Description
int

m_entries

buffered term entries

Declaration

protected BytesRefArray m_entries

Field Value

Type	Description
BytesRefArray

m_freqs

buffered weights, parallel with m_entries

Declaration

protected long[] m_freqs

Field Value

Type	Description
long[]

Properties

Comparer

Return the Lucene.Net.Util.BytesRef Comparer used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.

Declaration

public virtual IComparer<BytesRef> Comparer { get; }

Property Value

Type	Description
IComparer<BytesRef>

Current

Gets the Lucene.Net.Util.BytesRef for the current iteration. The returned Lucene.Net.Util.BytesRef may be reused across calls to Lucene.Net.Util.IBytesRefEnumerator.MoveNext().

Declaration

public virtual BytesRef Current { get; }

Property Value

Type	Description
BytesRef

Weight

Gets the term's weight, higher numbers mean better suggestions.

Declaration

public virtual long Weight { get; }

Property Value

Type	Description
long

Methods

MoveNext()

Increments the iteration to the next Lucene.Net.Util.BytesRef in the enumerator.

Declaration

public virtual bool MoveNext()

Returns

Type	Description
bool	true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

Type	Condition
IOException	If there is a low-level I/O error.

Implements

ITermFreqEnumerator

Lucene.Net.Util.IBytesRefEnumerator