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

- Packages that use FieldInfos
  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.index | Code to maintain and access indices.

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

    Methods in org.apache.lucene.codecs that return FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `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)`.

    Methods in org.apache.lucene.codecs with parameters of type FieldInfos
    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 void` | StoredFieldsWriter.`finish(FieldInfos fis, int numDocs)` Called before `StoredFieldsWriter.close()`, passing in the number of documents that were written.
    `abstract void` | TermVectorsWriter.`finish(FieldInfos fis, int numDocs)` Called before `TermVectorsWriter.close()`, passing in the number of documents that were written.
    `abstract TermVectorsReader` | TermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)` Returns a `TermVectorsReader` to read term vectors.
    `abstract void` | FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)` Writes the provided `FieldInfos` to the directory.

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

    Methods in org.apache.lucene.codecs.compressing with parameters of type FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | CompressingStoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `void` | CompressingStoredFieldsWriter.`finish(FieldInfos fis, int numDocs)`
    `void` | CompressingTermVectorsWriter.`finish(FieldInfos fis, int numDocs)`
    `TermVectorsReader` | CompressingTermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)`

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

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

    Methods in org.apache.lucene.codecs.lucene50 that return FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfos` | Lucene50FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context)`

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

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

    Methods in org.apache.lucene.codecs.lucene60 that return FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfos` | Lucene60FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context)`

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

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

    Fields in org.apache.lucene.index declared as FieldInfos
    Modifier and Type | Field and Description
    --- | ---
    `static FieldInfos` | FieldInfos.`EMPTY` An instance without any fields.
    `FieldInfos` | SegmentReadState.`fieldInfos` `FieldInfos` describing all fields in this segment.
    `FieldInfos[]` | MergeState.`fieldInfos` FieldInfos being merged
    `FieldInfos` | SegmentWriteState.`fieldInfos` `FieldInfos` describing all fields in this segment.
    `FieldInfos` | MergeState.`mergeFieldInfos` `FieldInfos` of the newly merged segment.

    Methods in org.apache.lucene.index that return FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfos` | FilterLeafReader.`getFieldInfos()`
    `FieldInfos` | FilterCodecReader.`getFieldInfos()`
    `FieldInfos` | SegmentReader.`getFieldInfos()`
    `abstract FieldInfos` | LeafReader.`getFieldInfos()` Get the `FieldInfos` describing all fields in this reader.
    `FieldInfos` | ParallelLeafReader.`getFieldInfos()` Get the `FieldInfos` describing all fields in this reader.
    `static FieldInfos` | FieldInfos.`getMergedFieldInfos(IndexReader reader)` Call this to get the (merged) FieldInfos for a composite reader.

    Constructors in org.apache.lucene.index with parameters of type FieldInfos
    Constructor and Description
    `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.