Show / Hide Table of Contents

    Class Lucene40LiveDocsFormat

    Lucene 4.0 Live Documents Format.

    The .del file is optional, and only exists when a segment contains deletions.

    Although per-segment, this file is maintained exterior to compound segment files.

    Deletions (.del) --> Format,Header,ByteCount,BitCount, Bits | DGaps (depending on Format)

    • Format,ByteSize,BitCount --> Uint32 (WriteInt32(Int32))
    • Bits --> < Byte (WriteByte(Byte)) > ByteCount
    • DGaps --> <DGap,NonOnesByte> NonzeroBytesCount
    • DGap --> VInt (WriteVInt32(Int32))
    • NonOnesByte --> Byte(WriteByte(Byte))
    • Header --> CodecHeader (WriteHeader(DataOutput, String, Int32))

    Format is 1: indicates cleared DGaps.

    ByteCount indicates the number of bytes in Bits. It is typically (SegSize/8)+1.

    BitCount indicates the number of bits that are currently set in Bits.

    Bits contains one bit for each document indexed. When the bit corresponding to a document number is cleared, that document is marked as deleted. Bit ordering is from least to most significant. Thus, if Bits contains two bytes, 0x00 and 0x02, then document 9 is marked as alive (not deleted).

    DGaps represents sparse bit-vectors more efficiently than Bits. It is made of DGaps on indexes of nonOnes bytes in Bits, and the nonOnes bytes themselves. The number of nonOnes bytes in Bits (NonOnesBytesCount) is not stored.

    For example, if there are 8000 bits and only bits 10,12,32 are cleared, DGaps would be used:

    (VInt) 1 , (byte) 20 , (VInt) 3 , (Byte) 1

    Inheritance
    System.Object
    LiveDocsFormat
    Lucene40LiveDocsFormat
    Namespace: Lucene.Net.Codecs.Lucene40
    Assembly: Lucene.Net.dll
    Syntax
    public class Lucene40LiveDocsFormat : LiveDocsFormat

    Constructors

    | Improve this Doc View Source

    Lucene40LiveDocsFormat()

    Sole constructor.

    Declaration
    public Lucene40LiveDocsFormat()

    Methods

    | Improve this Doc View Source

    Files(SegmentCommitInfo, ICollection<String>)

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

    NewLiveDocs(IBits)

    Declaration
    public override IMutableBits NewLiveDocs(IBits existing)
    Parameters
    Type Name Description
    IBits existing
    Returns
    Type Description
    IMutableBits
    Overrides
    LiveDocsFormat.NewLiveDocs(IBits)
    | Improve this Doc View Source

    NewLiveDocs(Int32)

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

    ReadLiveDocs(Directory, SegmentCommitInfo, IOContext)

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

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

    Declaration
    public override 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
    Overrides
    LiveDocsFormat.WriteLiveDocs(IMutableBits, Directory, SegmentCommitInfo, Int32, IOContext)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)