Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class PulsingPostingsReader

    Concrete class that reads the current doc/freq/skip postings format.

    Note

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

    Inheritance
    object
    PostingsReaderBase
    PulsingPostingsReader
    Implements
    IDisposable
    Inherited Members
    PostingsReaderBase.Dispose()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Pulsing
    Assembly: Lucene.Net.Codecs.dll
    Syntax
    public class PulsingPostingsReader : PostingsReaderBase, IDisposable

    Constructors

    PulsingPostingsReader(SegmentReadState, PostingsReaderBase)

    Concrete class that reads the current doc/freq/skip postings format.

    Note

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

    Declaration
    public PulsingPostingsReader(SegmentReadState state, PostingsReaderBase wrappedPostingsReader)
    Parameters
    Type Name Description
    SegmentReadState state
    PostingsReaderBase wrappedPostingsReader

    Methods

    CheckIntegrity()

    Checks consistency of this reader.

    Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Declaration
    public override void CheckIntegrity()
    Overrides
    Lucene.Net.Codecs.PostingsReaderBase.CheckIntegrity()

    DecodeTerm(long[], DataInput, FieldInfo, BlockTermState, bool)

    Actually decode metadata for next term.

    Declaration
    public override void DecodeTerm(long[] empty, DataInput input, FieldInfo fieldInfo, BlockTermState termState, bool absolute)
    Parameters
    Type Name Description
    long[] empty
    DataInput input
    FieldInfo fieldInfo
    BlockTermState termState
    bool absolute
    Overrides
    PostingsReaderBase.DecodeTerm(long[], DataInput, FieldInfo, BlockTermState, bool)
    See Also
    EncodeTerm(long[], DataOutput, FieldInfo, BlockTermState, bool)

    Dispose(bool)

    Implementations must override and should dispose all resources used by this instance.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing
    Overrides
    PostingsReaderBase.Dispose(bool)

    Docs(FieldInfo, BlockTermState, IBits, DocsEnum, DocsFlags)

    Must fully consume state, since after this call that Lucene.Net.Index.TermState may be reused.

    Declaration
    public override DocsEnum Docs(FieldInfo field, BlockTermState termState, IBits liveDocs, DocsEnum reuse, DocsFlags flags)
    Parameters
    Type Name Description
    FieldInfo field
    BlockTermState termState
    IBits liveDocs
    DocsEnum reuse
    DocsFlags flags
    Returns
    Type Description
    DocsEnum
    Overrides
    Lucene.Net.Codecs.PostingsReaderBase.Docs(Lucene.Net.Index.FieldInfo, Lucene.Net.Codecs.BlockTermState, Lucene.Net.Util.IBits, Lucene.Net.Index.DocsEnum, Lucene.Net.Index.DocsFlags)

    DocsAndPositions(FieldInfo, BlockTermState, IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)

    Must fully consume state, since after this call that Lucene.Net.Index.TermState may be reused.

    Declaration
    public override DocsAndPositionsEnum DocsAndPositions(FieldInfo field, BlockTermState termState, IBits liveDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)
    Parameters
    Type Name Description
    FieldInfo field
    BlockTermState termState
    IBits liveDocs
    DocsAndPositionsEnum reuse
    DocsAndPositionsFlags flags
    Returns
    Type Description
    DocsAndPositionsEnum
    Overrides
    Lucene.Net.Codecs.PostingsReaderBase.DocsAndPositions(Lucene.Net.Index.FieldInfo, Lucene.Net.Codecs.BlockTermState, Lucene.Net.Util.IBits, Lucene.Net.Index.DocsAndPositionsEnum, Lucene.Net.Index.DocsAndPositionsFlags)

    Init(IndexInput)

    Performs any initialization, such as reading and verifying the header from the provided terms dictionary Lucene.Net.Store.IndexInput.

    Declaration
    public override void Init(IndexInput termsIn)
    Parameters
    Type Name Description
    IndexInput termsIn
    Overrides
    Lucene.Net.Codecs.PostingsReaderBase.Init(Lucene.Net.Store.IndexInput)

    NewTermState()

    Return a newly created empty Lucene.Net.Index.TermState.

    Declaration
    public override BlockTermState NewTermState()
    Returns
    Type Description
    BlockTermState
    Overrides
    Lucene.Net.Codecs.PostingsReaderBase.NewTermState()

    RamBytesUsed()

    Returns approximate RAM bytes used.

    Declaration
    public override long RamBytesUsed()
    Returns
    Type Description
    long
    Overrides
    Lucene.Net.Codecs.PostingsReaderBase.RamBytesUsed()

    Implements

    IDisposable
    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.