Uses of Class org.apache.lucene.index.FieldInfo (Lucene 10.5.1 core API)
Description: use: package: org.apache.lucene.index, class: FieldInfo

# 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.hnsw
HNSW vector helper classes.
org.apache.lucene.codecs.lucene104
Lucene 10.4 file format.
org.apache.lucene.codecs.lucene90
Lucene 9.0 file format.
org.apache.lucene.codecs.lucene90.compressing
Lucene 9.0 compressing format.
org.apache.lucene.codecs.lucene99
Lucene 9.9 file format.
org.apache.lucene.codecs.perfield
Postings format that can delegate to different formats per-field.
org.apache.lucene.document
The logical representation of a `Document` for indexing and searching.
org.apache.lucene.index
Code to maintain and access indices.
org.apache.lucene.internal.tests
Internal bridges to package-private internals, for use by the lucene test framework only.
org.apache.lucene.util.hnsw
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
org.apache.lucene.util.quantization
Provides quantization methods for scaling vector values to smaller data types and possibly fewer dimensions

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

  Fields in org.apache.lucene.codecs declared as FieldInfo
  Modifier and Type
  Field
  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
  Description
  `abstract void`
  DocValuesConsumer.`addBinaryField(FieldInfo field, DocValuesProducer valuesProducer)`
  Writes binary docvalues for a field.
  `KnnFieldVectorsWriter<?>`
  BufferingKnnVectorsWriter.`addField(FieldInfo fieldInfo)`
  `abstract KnnFieldVectorsWriter<?>`
  KnnVectorsWriter.`addField(FieldInfo fieldInfo)`
  Add new field for indexing
  `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)`
  `void`
  StoredFieldsWriter.MergeVisitor.`binaryField(FieldInfo fieldInfo, StoredFieldDataInput value)`
  `protected static OrdinalMap`
  DocValuesConsumer.`createOrdinalMapForSortedDV(FieldInfo fieldInfo, MergeState mergeState)`
  Returns a merged sorted doc values instance from all producers in the provided merge state.
  `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.
  `protected static BinaryDocValues`
  DocValuesConsumer.`getMergedBinaryDocValues(FieldInfo mergeFieldInfo, MergeState mergeState)`
  Returns a merged binary doc values instance from all producers in the provided merge state.
  `protected static NumericDocValues`
  DocValuesConsumer.`getMergedNumericDocValues(MergeState mergeState, FieldInfo mergeFieldInfo)`
  Returns a merged numeric doc values instance from all producers in the provided merge state.
  `protected static SortedNumericDocValues`
  DocValuesConsumer.`getMergedSortedNumericDocValues(FieldInfo mergeFieldInfo, MergeState mergeState)`
  Returns a merged sorted numeric doc values instance from all producers in the provided merge state.
  `protected static SortedDocValues`
  DocValuesConsumer.`getMergedSortedSetDocValues(FieldInfo fieldInfo, MergeState mergeState, OrdinalMap map)`
  Returns a merged sorted doc values instance from all producers in the provided merge state.
  `protected static SortedSetDocValues`
  DocValuesConsumer.`getMergedSortedSetDocValues(FieldInfo mergeFieldInfo, MergeState mergeState, OrdinalMap map, List<SortedSetDocValues> toMerge)`
  Returns a sorted set doc values instance from all producers in the provided merge state.
  `abstract NumericDocValues`
  NormsProducer.`getNorms(FieldInfo field)`
  Returns `NumericDocValues` for this field.
  `abstract NumericDocValues`
  DocValuesProducer.`getNumeric(FieldInfo field)`
  Returns `NumericDocValues` for this field.
  `Map<String,Long>`
  KnnVectorsReader.`getOffHeapByteSize(FieldInfo fieldInfo)`
  Returns the desired size of off-heap memory for the given field.
  `abstract DocValuesSkipper`
  DocValuesProducer.`getSkipper(FieldInfo field)`
  Returns a `DocValuesSkipper` 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`.
  `static ByteVectorValues`
  KnnVectorsWriter.MergedVectorValues.`mergeByteVectorValues(FieldInfo fieldInfo, MergeState mergeState)`
  Returns a merged view over all the segment's `ByteVectorValues`.
  `static FloatVectorValues`
  KnnVectorsWriter.MergedVectorValues.`mergeFloatVectorValues(FieldInfo fieldInfo, MergeState mergeState)`
  Returns a merged view over all the segment's `FloatVectorValues`.
  `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`.
  `IORunnable`
  BufferingKnnVectorsWriter.`mergeOneField(FieldInfo fieldInfo, MergeState mergeState)`
  `IORunnable`
  KnnVectorsWriter.`mergeOneField(FieldInfo fieldInfo, MergeState mergeState)`
  Merges vectors for a single field, returning a runnable for any deferred work (e.g., HNSW graph construction).
  `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.
  `protected static List<SortedSetDocValues>`
  DocValuesConsumer.`selectLeavesToMerge(FieldInfo mergeFieldInfo, MergeState mergeState)`
  Selects the sorted set doc values to merge.
  `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, String value)`
  `protected abstract void`
  BufferingKnnVectorsWriter.`writeField(FieldInfo fieldInfo, ByteVectorValues byteVectorValues, int maxDoc)`
  Write the provided byte vector field
  `protected abstract void`
  BufferingKnnVectorsWriter.`writeField(FieldInfo fieldInfo, FloatVectorValues floatVectorValues, int maxDoc)`
  Write the provided float vector field
  `abstract void`
  PointsWriter.`writeField(FieldInfo fieldInfo, PointsReader values)`
  Write all values contained in the provided reader
  `abstract void`
  StoredFieldsWriter.`writeField(FieldInfo info, double value)`
  Writes a stored double value.
  `abstract void`
  StoredFieldsWriter.`writeField(FieldInfo info, float value)`
  Writes a stored float value.
  `abstract void`
  StoredFieldsWriter.`writeField(FieldInfo info, int value)`
  Writes a stored int value.
  `abstract void`
  StoredFieldsWriter.`writeField(FieldInfo info, long value)`
  Writes a stored long value.
  `abstract void`
  StoredFieldsWriter.`writeField(FieldInfo info, String value)`
  Writes a stored String value.
  `void`
  StoredFieldsWriter.`writeField(FieldInfo info, StoredFieldDataInput value)`
  Writes a stored binary value from a `StoredFieldDataInput`.
  `abstract void`
  StoredFieldsWriter.`writeField(FieldInfo info, BytesRef value)`
  Writes a stored binary value.

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

  Methods in org.apache.lucene.codecs.hnsw with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `abstract FlatFieldVectorsWriter<?>`
  FlatVectorsWriter.`addField(FieldInfo fieldInfo)`
  Add a new field for indexing
  `final IORunnable`
  FlatVectorsWriter.`mergeOneField(FieldInfo fieldInfo, MergeState mergeState)`
  `abstract void`
  FlatVectorsWriter.`mergeOneFlatVectorField(FieldInfo fieldInfo, MergeState mergeState)`

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

  Methods in org.apache.lucene.codecs.lucene104 with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `FlatFieldVectorsWriter<?>`
  Lucene104ScalarQuantizedVectorsWriter.`addField(FieldInfo fieldInfo)`
  `void`
  Lucene104PostingsReader.`decodeTerm(DataInput in, FieldInfo fieldInfo, BlockTermState _termState, boolean absolute)`
  `void`
  Lucene104PostingsWriter.`encodeTerm(DataOutput out, FieldInfo fieldInfo, BlockTermState _state, boolean absolute)`
  `Map<String,Long>`
  Lucene104ScalarQuantizedVectorsReader.`getOffHeapByteSize(FieldInfo fieldInfo)`
  `CloseableRandomVectorScorerSupplier`
  Lucene104ScalarQuantizedVectorsReader.`getRandomVectorScorerSupplierForMerge(FieldInfo fieldInfo, SegmentWriteState segmentWriteState)`
  `ImpactsEnum`
  Lucene104PostingsReader.`impacts(FieldInfo fieldInfo, BlockTermState state, int flags)`
  `void`
  Lucene104ScalarQuantizedVectorsWriter.`mergeOneFlatVectorField(FieldInfo fieldInfo, MergeState mergeState)`
  `PostingsEnum`
  Lucene104PostingsReader.`postings(FieldInfo fieldInfo, BlockTermState termState, PostingsEnum reuse, int flags)`
  `void`
  Lucene104PostingsWriter.`setField(FieldInfo fieldInfo)`

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

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

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

  Methods in org.apache.lucene.codecs.lucene90.compressing with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `void`
  Lucene90CompressingTermVectorsWriter.`startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, double value)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, float value)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, int value)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, long value)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, String value)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, StoredFieldDataInput value)`
  `void`
  Lucene90CompressingStoredFieldsWriter.`writeField(FieldInfo info, BytesRef value)`

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

  Methods in org.apache.lucene.codecs.lucene99 with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `FlatFieldVectorsWriter<?>`
  Lucene99FlatVectorsWriter.`addField(FieldInfo fieldInfo)`
  `KnnFieldVectorsWriter<?>`
  Lucene99HnswVectorsWriter.`addField(FieldInfo fieldInfo)`
  `Map<String,Long>`
  Lucene99FlatVectorsReader.`getOffHeapByteSize(FieldInfo fieldInfo)`
  `Map<String,Long>`
  Lucene99HnswVectorsReader.`getOffHeapByteSize(FieldInfo fieldInfo)`
  `CloseableRandomVectorScorerSupplier`
  Lucene99HnswVectorsReader.`getRandomVectorScorerSupplierForMerge(FieldInfo fieldInfo, SegmentWriteState segmentWriteState)`
  `IORunnable`
  Lucene99HnswVectorsWriter.`mergeOneField(FieldInfo fieldInfo, MergeState mergeState)`
  `void`
  Lucene99FlatVectorsWriter.`mergeOneFlatVectorField(FieldInfo fieldInfo, MergeState mergeState)`
  Constructor parameters in org.apache.lucene.codecs.lucene99 with type arguments of type FieldInfo
  Modifier
  Constructor
  Description
  ``
  `Lucene99FlatVectorsWriter(SegmentWriteState state, FlatVectorsScorer scorer, IOFunction<FieldInfo,FlatFieldVectorsWriter<?>> strategyFactory)`
  Constructs a writer that uses the supplied `strategyFactory` to build per-field vector storage.

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

  Methods in org.apache.lucene.codecs.perfield with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `Map<String,Long>`
  PerFieldKnnVectorsFormat.FieldsReader.`getOffHeapByteSize(FieldInfo fieldInfo)`

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

  Methods in org.apache.lucene.document with parameters of type FieldInfo
  Modifier and Type
  Method
  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, String value)`

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

  Methods in org.apache.lucene.index that return FieldInfo
  Modifier and Type
  Method
  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
  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
  Description
  `void`
  StoredFieldVisitor.`binaryField(FieldInfo fieldInfo, byte[] value)`
  Process a binary field.
  `void`
  StoredFieldVisitor.`binaryField(FieldInfo fieldInfo, StoredFieldDataInput value)`
  Expert: Process a binary field directly from the `StoredFieldDataInput`.
  `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)`
  `DocValuesSkipper`
  EmptyDocValuesProducer.`getSkipper(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, String value)`
  Process a string field.
  Constructors in org.apache.lucene.index with parameters of type FieldInfo
  Modifier
  Constructor
  Description
  ``
  `FieldInfos(FieldInfo[] infos)`
  Constructs a new FieldInfos from an array of FieldInfo objects.

- ## Uses of FieldInfo in org.apache.lucene.internal.tests

  Methods in org.apache.lucene.internal.tests with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `IndexPackageAccess.FieldInfosBuilder`
  IndexPackageAccess.FieldInfosBuilder.`add(FieldInfo fi)`

- ## Uses of FieldInfo in org.apache.lucene.util.hnsw

  Fields in org.apache.lucene.util.hnsw declared as FieldInfo
  Modifier and Type
  Field
  Description
  `protected final FieldInfo`
  IncrementalHnswGraphMerger.`fieldInfo`
  Constructors in org.apache.lucene.util.hnsw with parameters of type FieldInfo
  Modifier
  Constructor
  Description
  ``
  `ConcurrentHnswMerger(FieldInfo fieldInfo, RandomVectorScorerSupplier scorerSupplier, int M, int beamWidth, TaskExecutor taskExecutor, int numWorker)`
  ``
  `ConcurrentHnswMerger(FieldInfo fieldInfo, RandomVectorScorerSupplier scorerSupplier, int M, int beamWidth, TaskExecutor taskExecutor, int numWorker, IORunnable abortCheck)`
  ``
  `IncrementalHnswGraphMerger(FieldInfo fieldInfo, RandomVectorScorerSupplier scorerSupplier, int M, int beamWidth)`
  ``
  `IncrementalHnswGraphMerger(FieldInfo fieldInfo, RandomVectorScorerSupplier scorerSupplier, int M, int beamWidth, IORunnable abortCheck)`

- ## Uses of FieldInfo in org.apache.lucene.util.quantization

  Methods in org.apache.lucene.util.quantization with parameters of type FieldInfo
  Modifier and Type
  Method
  Description
  `CloseableRandomVectorScorerSupplier`
  QuantizedVectorsReader.`getRandomVectorScorerSupplierForMerge(FieldInfo fieldInfo, SegmentWriteState segmentWriteState)`
  Provides a scorer for merging this quantized vector reader.