Class DocsEnum

Iterates through the documents and term freqs. NOTE: you must first call NextDoc() before using any of the per-doc methods.

Inheritance
System.Object
DocIdSetIterator
DocsEnum
MappingMultiDocsEnum
DocsAndPositionsEnum
FilterAtomicReader.FilterDocsEnum
MultiDocsEnum
Scorer
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.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class DocsEnum : DocIdSetIterator

Constructors

| Improve this Doc View Source

DocsEnum()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration
protected DocsEnum()

Properties

| Improve this Doc View Source

Attributes

Returns the related attributes.

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

Freq

Returns term frequency in the current document, or 1 if the field was indexed with DOCS_ONLY. Do not call this before NextDoc() is first called, nor after NextDoc() returns NO_MORE_DOCS.

NOTE: if the DocsEnum was obtain with NONE, the result of this method is undefined.

Declaration
public abstract int Freq { get; }
Property Value
Type Description
System.Int32

Extension Methods