Class MultiLevelSkipListReader

This abstract class reads skip lists with multiple levels.

See MultiLevelSkipListWriter for the information about the encoding of the multi level skip lists.

Subclasses must implement the abstract method ReadSkipData(int, IndexInput) which defines the actual format of the skip data.

Note

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

Inheritance
object
MultiLevelSkipListReader
Lucene40SkipListReader
Implements
Inherited Members
Namespace: Lucene.Net.Codecs
Assembly: Lucene.Net.dll
Syntax
public abstract class MultiLevelSkipListReader : IDisposable

Constructors

MultiLevelSkipListReader(IndexInput, int, int)

Creates a MultiLevelSkipListReader, where skipInterval and skipMultiplier are the same.

Declaration
protected MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)
Parameters
Type Name Description
IndexInput skipStream
int maxSkipLevels
int skipInterval

MultiLevelSkipListReader(IndexInput, int, int, int)

Creates a MultiLevelSkipListReader.

Declaration
protected MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval, int skipMultiplier)
Parameters
Type Name Description
IndexInput skipStream
int maxSkipLevels
int skipInterval
int skipMultiplier

Fields

m_maxNumberOfSkipLevels

The maximum number of skip levels possible for this index.

Declaration
protected int m_maxNumberOfSkipLevels
Field Value
Type Description
int

m_skipDoc

Doc id of current skip entry per level.

Declaration
protected int[] m_skipDoc
Field Value
Type Description
int[]

Properties

Doc

Returns the id of the doc to which the last call of SkipTo(int) has skipped.

Declaration
public virtual int Doc { get; }
Property Value
Type Description
int

Methods

Dispose()

Disposes all resources used by this object.

Declaration
public void Dispose()

Dispose(bool)

Disposes all resources used by this object. Subclasses may override to dispose their own resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Init(long, int)

Initializes the reader, for reuse on a new term.

Declaration
public virtual void Init(long skipPointer, int df)
Parameters
Type Name Description
long skipPointer
int df

ReadSkipData(int, IndexInput)

Subclasses must implement the actual skip data encoding in this method.

Declaration
protected abstract int ReadSkipData(int level, IndexInput skipStream)
Parameters
Type Name Description
int level

The level skip data shall be read from.
IndexInput skipStream

The skip stream to read from.
Returns
Type Description
int

SeekChild(int)

Seeks the skip entry on the given level.

Declaration
protected virtual void SeekChild(int level)
Parameters
Type Name Description
int level

SetLastSkipData(int)

Copies the values of the last read skip entry on this level.

Declaration
protected virtual void SetLastSkipData(int level)
Parameters
Type Name Description
int level

SkipTo(int)

Skips entries to the first beyond the current whose document number is greater than or equal to target. Returns the current doc count.

Declaration
public virtual int SkipTo(int target)
Parameters
Type Name Description
int target
Returns
Type Description
int

Implements