Class MultiDocValues.OrdinalMap

maps per-segment ordinals to/from global ordinal space

Inheritance

System.Object

MultiDocValues.OrdinalMap

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public class OrdinalMap : object

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
System.Object	owner	a cache key
TermsEnum[]	subs	TermsEnums that support Ord. They need not be dense (e.g. can be FilteredTermsEnums).

Properties

ValueCount

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

Declaration

public virtual long ValueCount { get; }

Property Value

Type	Description
System.Int64

Methods

GetFirstSegmentNumber(Int64)

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
System.Int64	globalOrd

Returns

Type	Description
System.Int32

GetFirstSegmentOrd(Int64)

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

Declaration

public virtual long GetFirstSegmentOrd(long globalOrd)

Parameters

Type	Name	Description
System.Int64	globalOrd

Returns

Type	Description
System.Int64

GetGlobalOrd(Int32, Int64)

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
System.Int32	segmentIndex
System.Int64	segmentOrd

Returns

Type	Description
System.Int64

RamBytesUsed()

Returns total byte size used by this ordinal map.

Declaration

public virtual long RamBytesUsed()

Returns

Type	Description
System.Int64