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

- Packages that use FieldInfo
  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.lucene84 | Components from the Lucene 8.4 index format.
  org.apache.lucene.codecs.lucene86 | Lucene 8.6 file format.
  org.apache.lucene.document | The logical representation of a `Document` for indexing and searching.
  org.apache.lucene.index | Code to maintain and access indices.

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

    Fields in org.apache.lucene.codecs declared as FieldInfo
    Modifier and Type | Field and Description
    --- | ---
    `protected FieldInfo` | PushPostingsWriterBase.`fieldInfo` `FieldInfo` of current field being written.

    Methods in org.apache.lucene.codecs with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | DocValuesConsumer.`addBinaryField(FieldInfo field, DocValuesProducer valuesProducer)` Writes binary docvalues for a field.
    `abstract void` | NormsConsumer.`addNormsField(FieldInfo field, NormsProducer normsProducer)` Writes normalization values for a field.
    `abstract void` | DocValuesConsumer.`addNumericField(FieldInfo field, DocValuesProducer valuesProducer)` Writes numeric docvalues for a field.
    `abstract void` | DocValuesConsumer.`addSortedField(FieldInfo field, DocValuesProducer valuesProducer)` Writes pre-sorted binary docvalues for a field.
    `abstract void` | DocValuesConsumer.`addSortedNumericField(FieldInfo field, DocValuesProducer valuesProducer)` Writes pre-sorted numeric docvalues for a field
    `abstract void` | DocValuesConsumer.`addSortedSetField(FieldInfo field, DocValuesProducer valuesProducer)` Writes pre-sorted set docvalues for a field
    `void` | StoredFieldsWriter.MergeVisitor.`binaryField(FieldInfo fieldInfo, byte[] value)`
    `abstract void` | PostingsReaderBase.`decodeTerm(DataInput in, FieldInfo fieldInfo, BlockTermState state, boolean absolute)` Actually decode metadata for next term
    `void` | StoredFieldsWriter.MergeVisitor.`doubleField(FieldInfo fieldInfo, double value)`
    `abstract void` | PostingsWriterBase.`encodeTerm(DataOutput out, FieldInfo fieldInfo, BlockTermState state, boolean absolute)` Encode metadata as long[] and byte[].
    `void` | StoredFieldsWriter.MergeVisitor.`floatField(FieldInfo fieldInfo, float value)`
    `abstract BinaryDocValues` | DocValuesProducer.`getBinary(FieldInfo field)` Returns `BinaryDocValues` for this field.
    `abstract NumericDocValues` | NormsProducer.`getNorms(FieldInfo field)` Returns `NumericDocValues` for this field.
    `abstract NumericDocValues` | DocValuesProducer.`getNumeric(FieldInfo field)` Returns `NumericDocValues` for this field.
    `abstract SortedDocValues` | DocValuesProducer.`getSorted(FieldInfo field)` Returns `SortedDocValues` for this field.
    `abstract SortedNumericDocValues` | DocValuesProducer.`getSortedNumeric(FieldInfo field)` Returns `SortedNumericDocValues` for this field.
    `abstract SortedSetDocValues` | DocValuesProducer.`getSortedSet(FieldInfo field)` Returns `SortedSetDocValues` for this field.
    `abstract ImpactsEnum` | PostingsReaderBase.`impacts(FieldInfo fieldInfo, BlockTermState state, int flags)` Return a `ImpactsEnum` that computes impacts with `scorer`.
    `void` | StoredFieldsWriter.MergeVisitor.`intField(FieldInfo fieldInfo, int value)`
    `void` | StoredFieldsWriter.MergeVisitor.`longField(FieldInfo fieldInfo, long value)`
    `void` | DocValuesConsumer.`mergeBinaryField(FieldInfo mergeFieldInfo, MergeState mergeState)` Merges the binary docvalues from `MergeState`.
    `void` | NormsConsumer.`mergeNormsField(FieldInfo mergeFieldInfo, MergeState mergeState)` Merges the norms from `toMerge`.
    `void` | DocValuesConsumer.`mergeNumericField(FieldInfo mergeFieldInfo, MergeState mergeState)` Merges the numeric docvalues from `MergeState`.
    `protected void` | PointsWriter.`mergeOneField(MergeState mergeState, FieldInfo fieldInfo)` Default naive merge implementation for one field: it just re-indexes all the values from the incoming segment.
    `void` | DocValuesConsumer.`mergeSortedField(FieldInfo fieldInfo, MergeState mergeState)` Merges the sorted docvalues from `toMerge`.
    `void` | DocValuesConsumer.`mergeSortedNumericField(FieldInfo mergeFieldInfo, MergeState mergeState)` Merges the sorted docvalues from `toMerge`.
    `void` | DocValuesConsumer.`mergeSortedSetField(FieldInfo mergeFieldInfo, MergeState mergeState)` Merges the sortedset docvalues from `toMerge`.
    `StoredFieldVisitor.Status` | StoredFieldsWriter.MergeVisitor.`needsField(FieldInfo fieldInfo)`
    `abstract PostingsEnum` | PostingsReaderBase.`postings(FieldInfo fieldInfo, BlockTermState state, PostingsEnum reuse, int flags)` Must fully consume state, since after this call that TermState may be reused.
    `abstract void` | PostingsWriterBase.`setField(FieldInfo fieldInfo)` Sets the current field for writing.
    `void` | PushPostingsWriterBase.`setField(FieldInfo fieldInfo)` Sets the current field for writing, and returns the fixed length of long[] metadata (which is fixed per field), called when the writing switches to another field.
    `abstract void` | TermVectorsWriter.`startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads)` Called before writing the terms of the field.
    `void` | StoredFieldsWriter.MergeVisitor.`stringField(FieldInfo fieldInfo, byte[] value)`
    `abstract void` | StoredFieldsWriter.`writeField(FieldInfo info, IndexableField field)` Writes a single stored field.
    `abstract void` | PointsWriter.`writeField(FieldInfo fieldInfo, PointsReader values)` Write all values contained in the provided reader

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

    Methods in org.apache.lucene.codecs.compressing with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompressingTermVectorsWriter.`startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads)`
    `void` | CompressingStoredFieldsWriter.`writeField(FieldInfo info, IndexableField field)`

  - ### Uses of FieldInfo in org.apache.lucene.codecs.lucene84

    Methods in org.apache.lucene.codecs.lucene84 with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene84PostingsReader.`decodeTerm(DataInput in, FieldInfo fieldInfo, BlockTermState _termState, boolean absolute)`
    `void` | Lucene84PostingsWriter.`encodeTerm(DataOutput out, FieldInfo fieldInfo, BlockTermState _state, boolean absolute)`
    `ImpactsEnum` | Lucene84PostingsReader.`impacts(FieldInfo fieldInfo, BlockTermState state, int flags)`
    `PostingsEnum` | Lucene84PostingsReader.`postings(FieldInfo fieldInfo, BlockTermState termState, PostingsEnum reuse, int flags)`
    `void` | Lucene84PostingsWriter.`setField(FieldInfo fieldInfo)`

  - ### Uses of FieldInfo in org.apache.lucene.codecs.lucene86

    Methods in org.apache.lucene.codecs.lucene86 with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene86PointsWriter.`writeField(FieldInfo fieldInfo, PointsReader reader)`

  - ### Uses of FieldInfo in org.apache.lucene.document

    Methods in org.apache.lucene.document with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | DocumentStoredFieldVisitor.`binaryField(FieldInfo fieldInfo, byte[] value)`
    `void` | DocumentStoredFieldVisitor.`doubleField(FieldInfo fieldInfo, double value)`
    `void` | DocumentStoredFieldVisitor.`floatField(FieldInfo fieldInfo, float value)`
    `void` | DocumentStoredFieldVisitor.`intField(FieldInfo fieldInfo, int value)`
    `void` | DocumentStoredFieldVisitor.`longField(FieldInfo fieldInfo, long value)`
    `StoredFieldVisitor.Status` | DocumentStoredFieldVisitor.`needsField(FieldInfo fieldInfo)`
    `void` | DocumentStoredFieldVisitor.`stringField(FieldInfo fieldInfo, byte[] value)`

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

    Methods in org.apache.lucene.index that return FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfo` | FieldInfos.`fieldInfo(int fieldNumber)` Return the fieldinfo object referenced by the fieldNumber.
    `FieldInfo` | FieldInfos.`fieldInfo(String fieldName)` Return the fieldinfo object referenced by the field name

    Methods in org.apache.lucene.index that return types with arguments of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<FieldInfo>` | FieldInfos.`iterator()` Returns an iterator over all the fieldinfo objects present, ordered by ascending field number

    Methods in org.apache.lucene.index with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `void` | StoredFieldVisitor.`binaryField(FieldInfo fieldInfo, byte[] value)` Process a binary field.
    `void` | StoredFieldVisitor.`doubleField(FieldInfo fieldInfo, double value)` Process a double numeric field.
    `void` | StoredFieldVisitor.`floatField(FieldInfo fieldInfo, float value)` Process a float numeric field.
    `BinaryDocValues` | EmptyDocValuesProducer.`getBinary(FieldInfo field)`
    `NumericDocValues` | EmptyDocValuesProducer.`getNumeric(FieldInfo field)`
    `SortedDocValues` | EmptyDocValuesProducer.`getSorted(FieldInfo field)`
    `SortedNumericDocValues` | EmptyDocValuesProducer.`getSortedNumeric(FieldInfo field)`
    `SortedSetDocValues` | EmptyDocValuesProducer.`getSortedSet(FieldInfo field)`
    `void` | StoredFieldVisitor.`intField(FieldInfo fieldInfo, int value)` Process a int numeric field.
    `void` | StoredFieldVisitor.`longField(FieldInfo fieldInfo, long value)` Process a long numeric field.
    `abstract StoredFieldVisitor.Status` | StoredFieldVisitor.`needsField(FieldInfo fieldInfo)` Hook before processing a field.
    `void` | StoredFieldVisitor.`stringField(FieldInfo fieldInfo, byte[] value)` Process a string field; the provided byte[] value is a UTF-8 encoded string value.

    Constructors in org.apache.lucene.index with parameters of type FieldInfo
    Constructor and Description
    `FieldInfos(FieldInfo[] infos)` Constructs a new FieldInfos from an array of FieldInfo objects

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