Class MultiDocValues.OrdinalMap

maps per-segment ordinals to/from global ordinal space

Inheritance
object
MultiDocValues.OrdinalMap
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class MultiDocValues.OrdinalMap

Constructors

OrdinalMap(object, TermsEnum[])

Creates an ordinal map that allows mapping ords to/from a merged space from subs.

Declaration
public OrdinalMap(object owner, TermsEnum[] subs)
Parameters
Type Name Description
object owner

a cache key
TermsEnum[] subs

TermsEnums that support Ord. They need not be dense (e.g. can be FilteredTermsEnums).
Exceptions
Type Condition
IOException

if an I/O error occurred.

Properties

ValueCount

Returns the total number of unique terms in global ord space.

Declaration
public virtual long ValueCount { get; }
Property Value
Type Description
long

Methods

GetFirstSegmentNumber(long)

Given a global ordinal, returns the index of the first segment that contains this term.

Declaration
public virtual int GetFirstSegmentNumber(long globalOrd)
Parameters
Type Name Description
long globalOrd
Returns
Type Description
int

GetFirstSegmentOrd(long)

Given global ordinal, returns the ordinal of the first segment which contains this ordinal (the corresponding to the segment return GetFirstSegmentNumber(long)).

Declaration
public virtual long GetFirstSegmentOrd(long globalOrd)
Parameters
Type Name Description
long globalOrd
Returns
Type Description
long

GetGlobalOrd(int, long)

Given a segment number and segment ordinal, returns the corresponding global ordinal.

Declaration
public virtual long GetGlobalOrd(int segmentIndex, long segmentOrd)
Parameters
Type Name Description
int segmentIndex
long segmentOrd
Returns
Type Description
long

RamBytesUsed()

Returns total byte size used by this ordinal map.

Declaration
public virtual long RamBytesUsed()
Returns
Type Description
long