Class MultiDocsAndPositionsEnum

Exposes flex API, merged from flex API of sub-segments.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

DocIdSetIterator

DocsEnum

DocsAndPositionsEnum

MultiDocsAndPositionsEnum

Inherited Members

DocsEnum.Attributes

DocIdSetIterator.GetEmpty()

DocIdSetIterator.NO_MORE_DOCS

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public sealed class MultiDocsAndPositionsEnum : DocsAndPositionsEnum

Constructors

MultiDocsAndPositionsEnum(MultiTermsEnum, int)

Sole constructor.

Declaration

public MultiDocsAndPositionsEnum(MultiTermsEnum parent, int subReaderCount)

Parameters

Type	Name	Description
MultiTermsEnum	parent
int	subReaderCount

Properties

DocID

Returns the following:

• -1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet.
• 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

DocIdSetIterator.DocID

EndOffset

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

Declaration

public override int EndOffset { get; }

Property Value

Type	Description
int

Overrides

DocsAndPositionsEnum.EndOffset

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 override int Freq { get; }

Property Value

Type	Description
int

Overrides

DocsEnum.Freq

NumSubs

How many sub-readers we are merging.

Declaration

public int NumSubs { get; }

Property Value

Type	Description
int

StartOffset

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

Declaration

public override int StartOffset { get; }

Property Value

Type	Description
int

Overrides

DocsAndPositionsEnum.StartOffset

Subs

Returns sub-readers we are merging.

Declaration

public MultiDocsAndPositionsEnum.EnumWithSlice[] Subs { get; }

Property Value

Type	Description
EnumWithSlice[]

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 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 NO_MORE_DOCS for efficiency by some 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

DocIdSetIterator.Advance(int)

CanReuse(MultiTermsEnum)

Returns true if this instance can be reused by the provided MultiTermsEnum.

Declaration

public bool CanReuse(MultiTermsEnum parent)

Parameters

Type	Name	Description
MultiTermsEnum	parent

Returns

Type	Description
bool

GetCost()

Returns the estimated cost of this DocIdSetIterator.

This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

Declaration

public override long GetCost()

Returns

Type	Description
long

Overrides

DocIdSetIterator.GetCost()

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 override BytesRef GetPayload()

Returns

Type	Description
BytesRef

Overrides

DocsAndPositionsEnum.GetPayload()

NextDoc()

Advances to the next document in the set and returns the doc it is currently on, or 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

DocIdSetIterator.NextDoc()

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 override int NextPosition()

Returns

Type	Description
int

Overrides

DocsAndPositionsEnum.NextPosition()

Reset(EnumWithSlice[], int)

Re-use and reset this instance on the provided slices.

Declaration

public MultiDocsAndPositionsEnum Reset(MultiDocsAndPositionsEnum.EnumWithSlice[] subs, int numSubs)

Parameters

Type	Name	Description
EnumWithSlice[]	subs
int	numSubs

Returns

Type	Description
MultiDocsAndPositionsEnum

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()