## 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.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 FieldInfos in org.apache.lucene.codecs

    Methods in org.apache.lucene.codecs that return FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `abstract FieldInfos` | FieldInfosReader.`read(Directory directory, String segmentName, IOContext iocontext)` Read the `FieldInfos` previously written with `FieldInfosWriter`.

    Methods in org.apache.lucene.codecs with parameters of type FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | StoredFieldsWriter.`addDocument(Iterable<? extends IndexableField> doc, FieldInfos fieldInfos)` sugar method for startDocument() + writeField() for every stored field in the document
    `abstract StoredFieldsReader` | StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)` Returns a `StoredFieldsReader` to load stored fields.
    `abstract void` | TermVectorsWriter.`finish(FieldInfos fis, int numDocs)` Called before `TermVectorsWriter.close()`, passing in the number of documents that were written.
    `abstract void` | StoredFieldsWriter.`finish(FieldInfos fis, int numDocs)` Called before `StoredFieldsWriter.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` | SegmentInfoWriter.`write(Directory dir, SegmentInfo info, FieldInfos fis, IOContext ioContext)` Write `SegmentInfo` data.
    `abstract void` | FieldInfosWriter.`write(Directory directory, String segmentName, FieldInfos infos, IOContext context)` Writes the provided `FieldInfos` to the directory.

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

  - ### 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` | CompressingTermVectorsWriter.`finish(FieldInfos fis, int numDocs)`
    `void` | CompressingStoredFieldsWriter.`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.lucene40

    Methods in org.apache.lucene.codecs.lucene40 with parameters of type FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | Lucene40StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `void` | Lucene40TermVectorsWriter.`finish(FieldInfos fis, int numDocs)`
    `void` | Lucene40StoredFieldsWriter.`finish(FieldInfos fis, int numDocs)`
    `TermVectorsReader` | Lucene40TermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, 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 FieldInfos
    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 FieldInfos in org.apache.lucene.codecs.lucene41

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

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

    Fields in org.apache.lucene.index declared as FieldInfos
    Modifier and Type | Field and Description
    --- | ---
    `FieldInfos` | SegmentWriteState.`fieldInfos` `FieldInfos` describing all fields in this segment.
    `FieldInfos` | SegmentReadState.`fieldInfos` `FieldInfos` describing all fields in this segment.
    `FieldInfos` | MergeState.`fieldInfos` `FieldInfos` of the newly merged segment.

    Methods in org.apache.lucene.index that return FieldInfos
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfos` | SlowCompositeReaderWrapper.`getFieldInfos()`
    `FieldInfos` | SegmentReader.`getFieldInfos()`
    `FieldInfos` | ParallelAtomicReader.`getFieldInfos()` Get the `FieldInfos` describing all fields in this reader.
    `FieldInfos` | FilterAtomicReader.`getFieldInfos()`
    `abstract FieldInfos` | AtomicReader.`getFieldInfos()` Get the `FieldInfos` describing all fields in this reader.
    `static FieldInfos` | MultiFields.`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, 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.