Class DocumentDictionary.DocumentInputIterator

Implements IInputIterator from stored fields.

Inheritance
System.Object
DocumentDictionary.DocumentInputIterator
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Search.Suggest
Assembly: Lucene.Net.Suggest.dll
Syntax
protected class DocumentInputIterator : IInputIterator, IBytesRefIterator

Constructors

| Improve this Doc View Source

DocumentInputIterator(DocumentDictionary, Boolean, Boolean)

Creates an iterator over term, weight and payload fields from the lucene index. setting HasPayloads to false, implies an iterator over only term and weight.

Declaration
public DocumentInputIterator(DocumentDictionary outerInstance, bool hasPayloads, bool hasContexts)
Parameters
Type Name Description
DocumentDictionary outerInstance
System.Boolean hasPayloads
System.Boolean hasContexts

Properties

| Improve this Doc View Source

Comparer

Declaration
public virtual IComparer<BytesRef> Comparer { get; }
Property Value
Type Description
System.Collections.Generic.IComparer<BytesRef>
| Improve this Doc View Source

Contexts

Declaration
public virtual IEnumerable<BytesRef> Contexts { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<BytesRef>
| Improve this Doc View Source

HasContexts

Declaration
public virtual bool HasContexts { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

HasPayloads

Declaration
public virtual bool HasPayloads { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Payload

Declaration
public virtual BytesRef Payload { get; }
Property Value
Type Description
BytesRef
| Improve this Doc View Source

Weight

Declaration
public virtual long Weight { get; }
Property Value
Type Description
System.Int64

Methods

| Improve this Doc View Source

GetWeight(Document, Int32)

Returns the value of the Weight property for the current document. Retrieves the value for the Weight property if its stored (using doc) or if its indexed as NumericDocValues (using docId) for the document. If no value is found, then the weight is 0.

Declaration
protected virtual long GetWeight(Document doc, int docId)
Parameters
Type Name Description
Document doc
System.Int32 docId
Returns
Type Description
System.Int64
| Improve this Doc View Source

Next()

Declaration
public virtual BytesRef Next()
Returns
Type Description
BytesRef

Implements