Class DocsAndPositionsEnum

Also iterates through positions.

Inheritance
System.Object
DocIdSetIterator
DocsEnum
DocsAndPositionsEnum
MappingMultiDocsAndPositionsEnum
FilterAtomicReader.FilterDocsAndPositionsEnum
MultiDocsAndPositionsEnum
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 DocsAndPositionsEnum : DocsEnum

Constructors

| Improve this Doc View Source

DocsAndPositionsEnum()

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

Declaration
protected DocsAndPositionsEnum()

Properties

| Improve this Doc View Source

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
System.Int32
| Improve this Doc View Source

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
System.Int32

Methods

| Improve this Doc View Source

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
| Improve this Doc View Source

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
System.Int32