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

DocIdSetIterator.GetEmpty()

DocIdSetIterator.NO_MORE_DOCS

DocIdSetIterator.DocID

DocIdSetIterator.NextDoc()

DocIdSetIterator.Advance(Int32)

DocIdSetIterator.SlowAdvance(Int32)

DocIdSetIterator.GetCost()

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public abstract class DocsEnum : DocIdSetIterator

Constructors

DocsEnum()

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

Declaration

protected DocsEnum()

Properties

Attributes

Returns the related attributes.

Declaration

public virtual AttributeSource Attributes { get; }

Property Value

Type	Description
AttributeSource

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