Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class LiveDocsFormat

    Format for live/deleted documents.

    Note

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

    Inheritance
    System.Object
    LiveDocsFormat
    Lucene40LiveDocsFormat
    Inherited Members
    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
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class LiveDocsFormat

    Constructors

    | Improve this Doc View Source

    LiveDocsFormat()

    Sole constructor. (For invocation by subclass constructors, typically implicit.)

    Declaration
    protected LiveDocsFormat()

    Methods

    | Improve this Doc View Source

    Files(SegmentCommitInfo, ICollection<String>)

    Records all files in use by this SegmentCommitInfo into the files argument.

    Declaration
    public abstract void Files(SegmentCommitInfo info, ICollection<string> files)
    Parameters
    Type Name Description
    SegmentCommitInfo info
    System.Collections.Generic.ICollection<System.String> files
    | Improve this Doc View Source

    NewLiveDocs(IBits)

    Creates a new mutablebits of the same bits set and size of existing.

    Declaration
    public abstract IMutableBits NewLiveDocs(IBits existing)
    Parameters
    Type Name Description
    IBits existing
    Returns
    Type Description
    IMutableBits
    | Improve this Doc View Source

    NewLiveDocs(Int32)

    Creates a new MutableBits, with all bits set, for the specified size.

    Declaration
    public abstract IMutableBits NewLiveDocs(int size)
    Parameters
    Type Name Description
    System.Int32 size
    Returns
    Type Description
    IMutableBits
    | Improve this Doc View Source

    ReadLiveDocs(Directory, SegmentCommitInfo, IOContext)

    Read live docs bits.

    Declaration
    public abstract IBits ReadLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)
    Parameters
    Type Name Description
    Directory dir
    SegmentCommitInfo info
    IOContext context
    Returns
    Type Description
    IBits
    | Improve this Doc View Source

    WriteLiveDocs(IMutableBits, Directory, SegmentCommitInfo, Int32, IOContext)

    Persist live docs bits. Use NextDelGen to determine the generation of the deletes file you should write to.

    Declaration
    public abstract void WriteLiveDocs(IMutableBits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)
    Parameters
    Type Name Description
    IMutableBits bits
    Directory dir
    SegmentCommitInfo info
    System.Int32 newDelCount
    IOContext context
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 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.