Class AssertingDocsEnum

Wraps a Lucene.Net.Index.DocsEnum with additional checks

Inheritance
object
DocIdSetIterator
DocsEnum
FilterAtomicReader.FilterDocsEnum
AssertingDocsEnum
Inherited Members
FilterAtomicReader.FilterDocsEnum.m_input
FilterAtomicReader.FilterDocsEnum.Attributes
FilterAtomicReader.FilterDocsEnum.GetCost()
DocIdSetIterator.GetEmpty()
DocIdSetIterator.NO_MORE_DOCS
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.TestFramework.dll
Syntax
public class AssertingDocsEnum : FilterAtomicReader.FilterDocsEnum

Constructors

AssertingDocsEnum(DocsEnum)

Wraps a Lucene.Net.Index.DocsEnum with additional checks

Declaration
public AssertingDocsEnum(DocsEnum @in)
Parameters
Type Name Description
DocsEnum in

AssertingDocsEnum(DocsEnum, bool)

Wraps a Lucene.Net.Index.DocsEnum with additional checks

Declaration
public AssertingDocsEnum(DocsEnum @in, bool failOnUnsupportedDocID)
Parameters
Type Name Description
DocsEnum in
bool failOnUnsupportedDocID

Properties

DocID

Returns the following:

  • -1 or Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if Lucene.Net.Search.DocIdSetIterator.NextDoc() or Advance(int) were not called yet.
  • Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
  • Otherwise it should return the doc ID it is currently on.

@since 2.9

Declaration
public override int DocID { get; }
Property Value
Type Description
int
Overrides
Lucene.Net.Index.FilterAtomicReader.FilterDocsEnum.DocID

Freq

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

NOTE: if the Lucene.Net.Index.DocsEnum was obtain with Lucene.Net.Index.DocsFlags.NONE, the result of this method is undefined.
Declaration
public override int Freq { get; }
Property Value
Type Description
int
Overrides
Lucene.Net.Index.FilterAtomicReader.FilterDocsEnum.Freq

Methods

Advance(int)

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target <= current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it behaves as if written: 
int Advance(int target) 
{
    int doc;
    while ((doc = NextDoc()) < target) 
    {
    }
    return doc;
}

Some implementations are considerably more efficient than that.

NOTE: this method may be called with Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS for efficiency by some Lucene.Net.Search.Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

@since 2.9

Declaration
public override int Advance(int target)
Parameters
Type Name Description
int target
Returns
Type Description
int
Overrides

NextDoc()

Advances to the next document in the set and returns the doc it is currently on, or Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

@since 2.9
Declaration
public override int NextDoc()
Returns
Type Description
int
Overrides
Lucene.Net.Index.FilterAtomicReader.FilterDocsEnum.NextDoc()