Class BufferedInputEnumerator

This wrapper buffers incoming elements.

Note

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

Inheritance

object

BufferedInputEnumerator

UnsortedInputEnumerator

Implements

IInputEnumerator

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 BufferedInputEnumerator : IInputEnumerator, IBytesRefEnumerator

Constructors

BufferedInputEnumerator(IInputEnumerator)

Creates a new iterator, buffering entries from the specified iterator

Declaration

public BufferedInputEnumerator(IInputEnumerator source)

Parameters

Type	Name	Description
IInputEnumerator	source

Fields

m_contextSets

buffered context set entries

Declaration

protected IList<ICollection<BytesRef>> m_contextSets

Field Value

Type	Description
IList<ICollection<BytesRef>>

m_curPos

current buffer position

Declaration

protected int m_curPos

Field Value

Type	Description
int

m_current

This wrapper buffers incoming elements.

Note

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

Declaration

protected BytesRef m_current

Field Value

Type	Description
BytesRef

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[]

m_payloads

buffered payload entries

Declaration

protected BytesRefArray m_payloads

Field Value

Type	Description
BytesRefArray

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>

Contexts

A term's contexts context can be used to filter suggestions. May return null, if suggest entries do not have any context

Declaration

public virtual ICollection<BytesRef> Contexts { get; }

Property Value

Type	Description
ICollection<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

HasContexts

Returns true if the iterator has contexts

Declaration

public virtual bool HasContexts { get; }

Property Value

Type	Description
bool

HasPayloads

Returns true if the iterator has payloads

Declaration

public virtual bool HasPayloads { get; }

Property Value

Type	Description
bool

Payload

An arbitrary byte[] to record per suggestion. See Payload to retrieve the payload for each suggestion.

Declaration

public virtual BytesRef Payload { get; }

Property Value

Type	Description
BytesRef

Weight

A 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

IInputEnumerator

Lucene.Net.Util.IBytesRefEnumerator