Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class PulsingPostingsWriter

    Writer for the pulsing format.

    Wraps another postings implementation and decides (based on total number of occurrences), whether a terms postings should be inlined into the term dictionary, or passed through to the wrapped writer.

    Note

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

    Inheritance
    System.Object
    Lucene.Net.Codecs.PostingsConsumer
    Lucene.Net.Codecs.PostingsWriterBase
    PulsingPostingsWriter
    Implements
    System.IDisposable
    Inherited Members
    Lucene.Net.Codecs.PostingsWriterBase.Dispose()
    Lucene.Net.Codecs.PostingsConsumer.Merge(Lucene.Net.Index.MergeState, Lucene.Net.Index.IndexOptions, Lucene.Net.Index.DocsEnum, Lucene.Net.Util.FixedBitSet)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Codecs.Pulsing
    Assembly: Lucene.Net.Codecs.dll
    Syntax
    public sealed class PulsingPostingsWriter : PostingsWriterBase, IDisposable

    Constructors

    | Improve this Doc View Source

    PulsingPostingsWriter(SegmentWriteState, Int32, PostingsWriterBase)

    If the total number of positions (summed across all docs for this term) is less than or equal maxPositions, then the postings are inlined into terms dict.

    Declaration
    public PulsingPostingsWriter(SegmentWriteState state, int maxPositions, PostingsWriterBase wrappedPostingsWriter)
    Parameters
    Type Name Description
    Lucene.Net.Index.SegmentWriteState state
    System.Int32 maxPositions
    Lucene.Net.Codecs.PostingsWriterBase wrappedPostingsWriter

    Methods

    | Improve this Doc View Source

    AddPosition(Int32, BytesRef, Int32, Int32)

    Declaration
    public override void AddPosition(int position, BytesRef payload, int startOffset, int endOffset)
    Parameters
    Type Name Description
    System.Int32 position
    Lucene.Net.Util.BytesRef payload
    System.Int32 startOffset
    System.Int32 endOffset
    Overrides
    Lucene.Net.Codecs.PostingsConsumer.AddPosition(System.Int32, Lucene.Net.Util.BytesRef, System.Int32, System.Int32)
    | Improve this Doc View Source

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.Dispose(System.Boolean)
    | Improve this Doc View Source

    EncodeTerm(Int64[], DataOutput, FieldInfo, BlockTermState, Boolean)

    Declaration
    public override void EncodeTerm(long[] empty, DataOutput output, FieldInfo fieldInfo, BlockTermState state, bool abs)
    Parameters
    Type Name Description
    System.Int64[] empty
    Lucene.Net.Store.DataOutput output
    Lucene.Net.Index.FieldInfo fieldInfo
    Lucene.Net.Codecs.BlockTermState state
    System.Boolean abs
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.EncodeTerm(System.Int64[], Lucene.Net.Store.DataOutput, Lucene.Net.Index.FieldInfo, Lucene.Net.Codecs.BlockTermState, System.Boolean)
    | Improve this Doc View Source

    FinishDoc()

    Declaration
    public override void FinishDoc()
    Overrides
    Lucene.Net.Codecs.PostingsConsumer.FinishDoc()
    | Improve this Doc View Source

    FinishTerm(BlockTermState)

    Called when we are done adding docs to this term.

    Declaration
    public override void FinishTerm(BlockTermState state)
    Parameters
    Type Name Description
    Lucene.Net.Codecs.BlockTermState state
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.FinishTerm(Lucene.Net.Codecs.BlockTermState)
    | Improve this Doc View Source

    Init(IndexOutput)

    Declaration
    public override void Init(IndexOutput termsOut)
    Parameters
    Type Name Description
    Lucene.Net.Store.IndexOutput termsOut
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.Init(Lucene.Net.Store.IndexOutput)
    | Improve this Doc View Source

    NewTermState()

    Declaration
    public override BlockTermState NewTermState()
    Returns
    Type Description
    Lucene.Net.Codecs.BlockTermState
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.NewTermState()
    | Improve this Doc View Source

    SetField(FieldInfo)

    Currently, this instance is re-used across fields, so our parent calls setField whenever the field changes.

    Declaration
    public override int SetField(FieldInfo fieldInfo)
    Parameters
    Type Name Description
    Lucene.Net.Index.FieldInfo fieldInfo
    Returns
    Type Description
    System.Int32
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.SetField(Lucene.Net.Index.FieldInfo)
    | Improve this Doc View Source

    StartDoc(Int32, Int32)

    Declaration
    public override void StartDoc(int docId, int termDocFreq)
    Parameters
    Type Name Description
    System.Int32 docId
    System.Int32 termDocFreq
    Overrides
    Lucene.Net.Codecs.PostingsConsumer.StartDoc(System.Int32, System.Int32)
    | Improve this Doc View Source

    StartTerm()

    Declaration
    public override void StartTerm()
    Overrides
    Lucene.Net.Codecs.PostingsWriterBase.StartTerm()

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2021 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.