Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Lucene40SkipListReader

    Implements the skip list reader for the 4.0 posting list format that stores positions and payloads.

    Inheritance
    object
    MultiLevelSkipListReader
    Lucene40SkipListReader
    Implements
    IDisposable
    Inherited Members
    MultiLevelSkipListReader.m_maxNumberOfSkipLevels
    MultiLevelSkipListReader.m_skipDoc
    MultiLevelSkipListReader.Doc
    MultiLevelSkipListReader.SkipTo(int)
    MultiLevelSkipListReader.Dispose()
    MultiLevelSkipListReader.Dispose(bool)
    MultiLevelSkipListReader.Init(long, int)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Lucene40
    Assembly: Lucene.Net.dll
    Syntax
    [Obsolete("Only for reading old 4.0 segments")]
    public class Lucene40SkipListReader : MultiLevelSkipListReader, IDisposable

    Constructors

    Lucene40SkipListReader(IndexInput, int, int)

    Sole constructor.

    Declaration
    public Lucene40SkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)
    Parameters
    Type Name Description
    IndexInput skipStream
    int maxSkipLevels
    int skipInterval
    See Also
    Lucene40PostingsFormat

    Properties

    FreqPointer

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

    Declaration
    public virtual long FreqPointer { get; }
    Property Value
    Type Description
    long
    See Also
    Lucene40PostingsFormat

    OffsetLength

    Returns the offset length (endOffset-startOffset) of the position stored just before the doc to which the last call of SkipTo(int) has skipped.

    Declaration
    public virtual int OffsetLength { get; }
    Property Value
    Type Description
    int
    See Also
    Lucene40PostingsFormat

    PayloadLength

    Returns the payload length of the payload stored just before the doc to which the last call of SkipTo(int) has skipped.

    Declaration
    public virtual int PayloadLength { get; }
    Property Value
    Type Description
    int
    See Also
    Lucene40PostingsFormat

    ProxPointer

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

    Declaration
    public virtual long ProxPointer { get; }
    Property Value
    Type Description
    long
    See Also
    Lucene40PostingsFormat

    Methods

    Init(long, long, long, int, bool, bool)

    Per-term initialization.

    Declaration
    public virtual void Init(long skipPointer, long freqBasePointer, long proxBasePointer, int df, bool storesPayloads, bool storesOffsets)
    Parameters
    Type Name Description
    long skipPointer
    long freqBasePointer
    long proxBasePointer
    int df
    bool storesPayloads
    bool storesOffsets
    See Also
    Lucene40PostingsFormat

    ReadSkipData(int, IndexInput)

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

    Declaration
    protected override 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
    Overrides
    MultiLevelSkipListReader.ReadSkipData(int, IndexInput)
    See Also
    Lucene40PostingsFormat

    SeekChild(int)

    Seeks the skip entry on the given level.

    Declaration
    protected override void SeekChild(int level)
    Parameters
    Type Name Description
    int level
    Overrides
    MultiLevelSkipListReader.SeekChild(int)
    See Also
    Lucene40PostingsFormat

    SetLastSkipData(int)

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

    Declaration
    protected override void SetLastSkipData(int level)
    Parameters
    Type Name Description
    int level
    Overrides
    MultiLevelSkipListReader.SetLastSkipData(int)
    See Also
    Lucene40PostingsFormat

    Implements

    IDisposable

    See Also

    Lucene40PostingsFormat
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.