## Uses of Class
org.apache.lucene.index.SegmentInfo

- Packages that use SegmentInfo
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.codecs.compressing | StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
  org.apache.lucene.codecs.lucene3x | Codec to support Lucene 3.x indexes (readonly)
  org.apache.lucene.codecs.lucene40 | Lucene 4.0 file format.
  org.apache.lucene.codecs.lucene41 | Lucene 4.1 file format.
  org.apache.lucene.index | Code to maintain and access indices.

- - ### Uses of SegmentInfo in org.apache.lucene.codecs

    Methods in org.apache.lucene.codecs that return SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `abstract SegmentInfo` | SegmentInfoReader.`read(Directory directory, String segmentName, IOContext context)` Read `SegmentInfo` data from a directory.

    Methods in org.apache.lucene.codecs with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `abstract StoredFieldsReader` | StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)` Returns a `StoredFieldsReader` to load stored fields.
    `abstract StoredFieldsWriter` | StoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)` Returns a `StoredFieldsWriter` to write stored fields.
    `abstract TermVectorsReader` | TermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)` Returns a `TermVectorsReader` to read term vectors.
    `abstract TermVectorsWriter` | TermVectorsFormat.`vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)` Returns a `TermVectorsWriter` to write term vectors.
    `abstract void` | SegmentInfoWriter.`write(Directory dir, SegmentInfo info, FieldInfos fis, IOContext ioContext)` Write `SegmentInfo` data.

    Constructors in org.apache.lucene.codecs with parameters of type SegmentInfo
    Constructor and Description
    `BlockTreeTermsReader(Directory dir, FieldInfos fieldInfos, SegmentInfo info, PostingsReaderBase postingsReader, IOContext ioContext, String segmentSuffix, int indexDivisor)` Sole constructor.

  - ### Uses of SegmentInfo in org.apache.lucene.codecs.compressing

    Methods in org.apache.lucene.codecs.compressing with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | CompressingStoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `StoredFieldsWriter` | CompressingStoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`
    `TermVectorsReader` | CompressingTermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)`
    `TermVectorsWriter` | CompressingTermVectorsFormat.`vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)`

    Constructors in org.apache.lucene.codecs.compressing with parameters of type SegmentInfo
    Constructor and Description
    `CompressingStoredFieldsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode)` Sole constructor.
    `CompressingStoredFieldsWriter(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize)` Sole constructor.
    `CompressingTermVectorsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode)` Sole constructor.
    `CompressingTermVectorsWriter(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize)` Sole constructor.

  - ### Uses of SegmentInfo in org.apache.lucene.codecs.lucene3x

    Methods in org.apache.lucene.codecs.lucene3x that return SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `SegmentInfo` | Lucene3xSegmentInfoReader.`read(Directory directory, String segmentName, IOContext context)` Deprecated.

    Methods in org.apache.lucene.codecs.lucene3x with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `static Set<String>` | Lucene3xCodec.`getDocStoreFiles(SegmentInfo info)` Deprecated. Returns file names for shared doc stores, if any, else null.
    `static boolean` | Lucene3xSegmentInfoFormat.`getDocStoreIsCompoundFile(SegmentInfo si)` Deprecated.
    `static int` | Lucene3xSegmentInfoFormat.`getDocStoreOffset(SegmentInfo si)` Deprecated.
    `static String` | Lucene3xSegmentInfoFormat.`getDocStoreSegment(SegmentInfo si)` Deprecated.

  - ### Uses of SegmentInfo in org.apache.lucene.codecs.lucene40

    Methods in org.apache.lucene.codecs.lucene40 that return SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `SegmentInfo` | Lucene40SegmentInfoReader.`read(Directory dir, String segment, IOContext context)`

    Methods in org.apache.lucene.codecs.lucene40 with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | Lucene40StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `StoredFieldsWriter` | Lucene40StoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`
    `TermVectorsReader` | Lucene40TermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)`
    `TermVectorsWriter` | Lucene40TermVectorsFormat.`vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)`
    `void` | Lucene40SegmentInfoWriter.`write(Directory dir, SegmentInfo si, FieldInfos fis, IOContext ioContext)` Save a single segment's info.

    Constructors in org.apache.lucene.codecs.lucene40 with parameters of type SegmentInfo
    Constructor and Description
    `Lucene40PostingsReader(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix)` Deprecated. Sole constructor.
    `Lucene40StoredFieldsReader(Directory d, SegmentInfo si, FieldInfos fn, IOContext context)` Sole constructor.
    `Lucene40TermVectorsReader(Directory d, SegmentInfo si, FieldInfos fieldInfos, IOContext context)` Sole constructor.

  - ### Uses of SegmentInfo in org.apache.lucene.codecs.lucene41

    Constructors in org.apache.lucene.codecs.lucene41 with parameters of type SegmentInfo
    Constructor and Description
    `Lucene41PostingsReader(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix)` Sole constructor.

  - ### Uses of SegmentInfo in org.apache.lucene.index

    Fields in org.apache.lucene.index declared as SegmentInfo
    Modifier and Type | Field and Description
    --- | ---
    `SegmentInfo` | SegmentInfoPerCommit.`info` The `SegmentInfo` that we wrap.
    `SegmentInfo` | SegmentWriteState.`segmentInfo` `SegmentInfo` describing this segment.
    `SegmentInfo` | SegmentReadState.`segmentInfo` `SegmentInfo` describing this segment.
    `SegmentInfo` | MergeState.`segmentInfo` `SegmentInfo` of the newly merged segment.

    Methods in org.apache.lucene.index with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `static String` | SegmentInfos.`write3xInfo(Directory dir, SegmentInfo si, IOContext context)` Deprecated.

    Constructors in org.apache.lucene.index with parameters of type SegmentInfo
    Constructor and Description
    `SegmentInfoPerCommit(SegmentInfo info, int delCount, long delGen)` Sole constructor.
    `SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor)` Create a `SegmentReadState`.
    `SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor, String segmentSuffix)` Create a `SegmentReadState`.
    `SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, org.apache.lucene.index.BufferedDeletes segDeletes, IOContext context)` Sole constructor.

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.