Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Lucene40SegmentInfoFormat

    Lucene 4.0 Segment info format.

    Files:

    • .si: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Attributes, Files
    Data types:

    • Header --> CodecHeader (WriteHeader(DataOutput, string, int))
    • SegSize --> Int32 (WriteInt32(int))
    • SegVersion --> String (WriteString(string))
    • Files --> ISet<String> (WriteStringSet(ISet<string>))
    • Diagnostics, Attributes --> IDictionary<String,String> (WriteStringStringMap(IDictionary<string, string>))
    • IsCompoundFile --> Int8 (WriteByte(byte))
    Field Descriptions:

    • SegVersion is the code version that created the segment.
    • SegSize is the number of documents contained in the segment index.
    • IsCompoundFile records whether the segment is written as a compound file or not. If this is -1, the segment is not a compound file. If it is 1, the segment is a compound file.
    • Checksum contains the CRC32 checksum of all bytes in the segments_N file up until the checksum. This is used to verify integrity of the file on opening the index.
    • The Diagnostics Map is privately written by IndexWriter, as a debugging aid, for each segment it creates. It includes metadata like the current Lucene version, OS, .NET/Java version, why the segment was created (merge, flush, addIndexes), etc.
    • Attributes: a key-value map of codec-private attributes.
    • Files is a list of files referred to by this segment.
    Note

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

    Inheritance
    object
    SegmentInfoFormat
    Lucene40SegmentInfoFormat
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Lucene40
    Assembly: Lucene.Net.dll
    Syntax
    [Obsolete("Only for reading old 4.0-4.5 segments, and supporting IndexWriter.AddIndexes()")]
    public class Lucene40SegmentInfoFormat : SegmentInfoFormat

    Constructors

    Lucene40SegmentInfoFormat()

    Sole constructor.

    Declaration
    public Lucene40SegmentInfoFormat()
    See Also
    SegmentInfos

    Fields

    SI_EXTENSION

    File extension used to store SegmentInfo.

    Declaration
    public const string SI_EXTENSION = "si"
    Field Value
    Type Description
    string
    See Also
    SegmentInfos

    Properties

    SegmentInfoReader

    Returns the SegmentInfoReader for reading SegmentInfo instances.

    Declaration
    public override SegmentInfoReader SegmentInfoReader { get; }
    Property Value
    Type Description
    SegmentInfoReader
    Overrides
    SegmentInfoFormat.SegmentInfoReader
    See Also
    SegmentInfos

    SegmentInfoWriter

    Returns the SegmentInfoWriter for writing SegmentInfo instances.

    Declaration
    public override SegmentInfoWriter SegmentInfoWriter { get; }
    Property Value
    Type Description
    SegmentInfoWriter
    Overrides
    SegmentInfoFormat.SegmentInfoWriter
    See Also
    SegmentInfos

    See Also

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