Class DocsAndPositionsEnum

Also iterates through positions.

Inheritance

object

DocIdSetIterator

DocsEnum

DocsAndPositionsEnum

MappingMultiDocsAndPositionsEnum

FilterAtomicReader.FilterDocsAndPositionsEnum

MultiDocsAndPositionsEnum

Inherited Members

DocsEnum.Freq

DocsEnum.Attributes

DocIdSetIterator.GetEmpty()

DocIdSetIterator.NO_MORE_DOCS

DocIdSetIterator.DocID

DocIdSetIterator.NextDoc()

DocIdSetIterator.Advance(int)

DocIdSetIterator.SlowAdvance(int)

DocIdSetIterator.GetCost()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public abstract class DocsAndPositionsEnum : DocsEnum

Constructors

DocsAndPositionsEnum()

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

Declaration

protected DocsAndPositionsEnum()

Properties

EndOffset

Returns end offset for the current position, or -1 if offsets were not indexed.

Declaration

public abstract int EndOffset { get; }

Property Value

Type	Description
int

StartOffset

Returns start offset for the current position, or -1 if offsets were not indexed.

Declaration

public abstract int StartOffset { get; }

Property Value

Type	Description
int

Methods

GetPayload()

Returns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).

Declaration

public abstract BytesRef GetPayload()

Returns

Type	Description
BytesRef

NextPosition()

Returns the next position. You should only call this up to Freq times else the behavior is not defined. If positions were not indexed this will return -1; this only happens if offsets were indexed and you passed needsOffset=true when pulling the enum.

Declaration

public abstract int NextPosition()

Returns

Type	Description
int