Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class PulsingPostingsFormat

    This postings format "inlines" the postings for terms that have low docFreq. It wraps another postings format, which is used for writing the non-inlined terms.

    Note

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

    Inheritance
    object
    PostingsFormat
    PulsingPostingsFormat
    Pulsing41PostingsFormat
    Inherited Members
    PostingsFormat.EMPTY
    PostingsFormat.SetPostingsFormatFactory(IPostingsFormatFactory)
    PostingsFormat.GetPostingsFormatFactory()
    PostingsFormat.Name
    PostingsFormat.ForName(string)
    PostingsFormat.AvailablePostingsFormats
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Codecs.Pulsing
    Assembly: Lucene.Net.Codecs.dll
    Syntax
    public abstract class PulsingPostingsFormat : PostingsFormat

    Constructors

    PulsingPostingsFormat(PostingsBaseFormat, int)

    This postings format "inlines" the postings for terms that have low docFreq. It wraps another postings format, which is used for writing the non-inlined terms.

    Note

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

    Declaration
    protected PulsingPostingsFormat(PostingsBaseFormat wrappedPostingsBaseFormat, int freqCutoff)
    Parameters
    Type Name Description
    PostingsBaseFormat wrappedPostingsBaseFormat
    int freqCutoff

    PulsingPostingsFormat(PostingsBaseFormat, int, int, int)

    Terms with freq less than or equal freqCutoff are inlined into terms dict.

    Declaration
    protected PulsingPostingsFormat(PostingsBaseFormat wrappedPostingsBaseFormat, int freqCutoff, int minBlockSize, int maxBlockSize)
    Parameters
    Type Name Description
    PostingsBaseFormat wrappedPostingsBaseFormat
    int freqCutoff
    int minBlockSize
    int maxBlockSize

    Properties

    FreqCutoff

    This postings format "inlines" the postings for terms that have low docFreq. It wraps another postings format, which is used for writing the non-inlined terms.

    Note

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

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

    Methods

    FieldsConsumer(SegmentWriteState)

    Writes a new segment.

    Declaration
    public override FieldsConsumer FieldsConsumer(SegmentWriteState state)
    Parameters
    Type Name Description
    SegmentWriteState state
    Returns
    Type Description
    FieldsConsumer
    Overrides
    Lucene.Net.Codecs.PostingsFormat.FieldsConsumer(Lucene.Net.Index.SegmentWriteState)

    FieldsProducer(SegmentReadState)

    Reads a segment. NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.

    Declaration
    public override FieldsProducer FieldsProducer(SegmentReadState state)
    Parameters
    Type Name Description
    SegmentReadState state
    Returns
    Type Description
    FieldsProducer
    Overrides
    Lucene.Net.Codecs.PostingsFormat.FieldsProducer(Lucene.Net.Index.SegmentReadState)

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    Lucene.Net.Codecs.PostingsFormat.ToString()
    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.