## 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.lucene50 | Components from the Lucene 5.0 index format See `org.apache.lucene.codecs.lucene80` for an overview of the index format.
  org.apache.lucene.codecs.lucene60 | Components from the Lucene 6.0 index format.
  org.apache.lucene.codecs.lucene70 | Components from the Lucene 7.0 index 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` | SegmentInfoFormat.`read(Directory directory, String segmentName, byte[] segmentID, 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 Directory` | CompoundFormat.`getCompoundReader(Directory dir, SegmentInfo si, IOContext context)` Returns a Directory view (read-only) for the compound files in this segment
    `abstract FieldInfos` | FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext iocontext)` Read the `FieldInfos` previously written with `FieldInfosFormat.write(org.apache.lucene.store.Directory, org.apache.lucene.index.SegmentInfo, java.lang.String, org.apache.lucene.index.FieldInfos, org.apache.lucene.store.IOContext)`.
    `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` | SegmentInfoFormat.`write(Directory dir, SegmentInfo info, IOContext ioContext)` Write `SegmentInfo` data.
    `abstract void` | CompoundFormat.`write(Directory dir, SegmentInfo si, IOContext context)` Packs the provided segment's files into a compound format.
    `abstract void` | FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)` Writes the provided `FieldInfos` to the directory.

  - ### 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, int maxDocsPerChunk, int blockSize)` 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, int blockSize)` Sole constructor.

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

    Methods in org.apache.lucene.codecs.lucene50 with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | Lucene50StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `StoredFieldsWriter` | Lucene50StoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`
    `Directory` | Lucene50CompoundFormat.`getCompoundReader(Directory dir, SegmentInfo si, IOContext context)`
    `FieldInfos` | Lucene50FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context)`
    `void` | Lucene50CompoundFormat.`write(Directory dir, SegmentInfo si, IOContext context)`
    `void` | Lucene50FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)`

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

    Methods in org.apache.lucene.codecs.lucene60 with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfos` | Lucene60FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context)`
    `void` | Lucene60FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)`

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

    Methods in org.apache.lucene.codecs.lucene70 that return SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `SegmentInfo` | Lucene70SegmentInfoFormat.`read(Directory dir, String segment, byte[] segmentID, IOContext context)`

    Methods in org.apache.lucene.codecs.lucene70 with parameters of type SegmentInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene70SegmentInfoFormat.`write(Directory dir, SegmentInfo si, IOContext ioContext)`

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

    Fields in org.apache.lucene.index declared as SegmentInfo
    Modifier and Type | Field and Description
    --- | ---
    `SegmentInfo` | SegmentCommitInfo.`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.

    Constructors in org.apache.lucene.index with parameters of type SegmentInfo
    Constructor and Description
    `SegmentCommitInfo(SegmentInfo info, int delCount, int softDelCount, long delGen, long fieldInfosGen, long docValuesGen)` Sole constructor.
    `SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, boolean openedFromWriter, IOContext context, Map<String,String> readerAttributes)` Create a `SegmentReadState`.
    `SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, boolean openedFromWriter, IOContext context, String segmentSuffix, Map<String,String> readerAttributes)` Create a `SegmentReadState`.
    `SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context)` Sole constructor.
    `SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context, String segmentSuffix)` Constructor which takes segment suffix.

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