## 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.lucene40 | Lucene 4.0 file format.
  org.apache.lucene.codecs.lucene41 | Lucene 4.1 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

    Methods in org.apache.lucene.codecs with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | DocValuesConsumer.`addBinaryField(FieldInfo field, Iterable<BytesRef> values)` Writes binary docvalues for a field.
    `abstract TermsConsumer` | FieldsConsumer.`addField(FieldInfo field)` Add a new field
    `TermsConsumer` | BlockTreeTermsWriter.`addField(FieldInfo field)`
    `abstract void` | DocValuesConsumer.`addNumericField(FieldInfo field, Iterable<Number> values)` Writes numeric docvalues for a field.
    `abstract void` | DocValuesConsumer.`addSortedField(FieldInfo field, Iterable<BytesRef> values, Iterable<Number> docToOrd)` Writes pre-sorted binary docvalues for a field.
    `abstract void` | DocValuesConsumer.`addSortedSetField(FieldInfo field, Iterable<BytesRef> values, Iterable<Number> docToOrdCount, Iterable<Number> ords)` Writes pre-sorted set docvalues for a field
    `abstract DocsEnum` | PostingsReaderBase.`docs(FieldInfo fieldInfo, BlockTermState state, Bits skipDocs, DocsEnum reuse, int flags)` Must fully consume state, since after this call that TermState may be reused.
    `abstract DocsAndPositionsEnum` | PostingsReaderBase.`docsAndPositions(FieldInfo fieldInfo, BlockTermState state, Bits skipDocs, DocsAndPositionsEnum reuse, int flags)` Must fully consume state, since after this call that TermState may be reused.
    `abstract BinaryDocValues` | DocValuesProducer.`getBinary(FieldInfo field)` Returns `BinaryDocValues` 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 SortedSetDocValues` | DocValuesProducer.`getSortedSet(FieldInfo field)` Returns `SortedSetDocValues` for this field.
    `void` | DocValuesConsumer.`mergeBinaryField(FieldInfo fieldInfo, MergeState mergeState, List<BinaryDocValues> toMerge)` Merges the binary docvalues from `toMerge`.
    `void` | DocValuesConsumer.`mergeNumericField(FieldInfo fieldInfo, MergeState mergeState, List<NumericDocValues> toMerge)` Merges the numeric docvalues from `toMerge`.
    `void` | DocValuesConsumer.`mergeSortedField(FieldInfo fieldInfo, MergeState mergeState, List<SortedDocValues> toMerge)` Merges the sorted docvalues from `toMerge`.
    `void` | DocValuesConsumer.`mergeSortedSetField(FieldInfo fieldInfo, MergeState mergeState, List<SortedSetDocValues> toMerge)` Merges the sortedset docvalues from `toMerge`.
    `abstract void` | PostingsReaderBase.`nextTerm(FieldInfo fieldInfo, BlockTermState state)` Actually decode metadata for next term
    `abstract void` | PostingsReaderBase.`readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState termState)` Reads data for all terms in the next block; this method should merely load the byte[] blob but not decode, which is done in `PostingsReaderBase.nextTerm(org.apache.lucene.index.FieldInfo, org.apache.lucene.codecs.BlockTermState)`.
    `abstract void` | PostingsWriterBase.`setField(FieldInfo fieldInfo)` 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.
    `abstract void` | StoredFieldsWriter.`writeField(FieldInfo info, IndexableField field)` Writes a single stored field.

  - ### 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.lucene40

    Methods in org.apache.lucene.codecs.lucene40 with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | Lucene40PostingsReader.`docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)` Deprecated.
    `DocsAndPositionsEnum` | Lucene40PostingsReader.`docsAndPositions(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsAndPositionsEnum reuse, int flags)` Deprecated.
    `void` | Lucene40PostingsReader.`nextTerm(FieldInfo fieldInfo, BlockTermState _termState)` Deprecated.
    `void` | Lucene40PostingsReader.`readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState _termState)` Deprecated.
    `void` | Lucene40TermVectorsWriter.`startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads)`
    `void` | Lucene40StoredFieldsWriter.`writeField(FieldInfo info, IndexableField field)`

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

    Methods in org.apache.lucene.codecs.lucene41 with parameters of type FieldInfo
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | Lucene41PostingsReader.`docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsAndPositionsEnum` | Lucene41PostingsReader.`docsAndPositions(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsAndPositionsEnum reuse, int flags)`
    `void` | Lucene41PostingsReader.`nextTerm(FieldInfo fieldInfo, BlockTermState _termState)`
    `void` | Lucene41PostingsReader.`readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState _termState)`
    `void` | Lucene41PostingsWriter.`setField(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 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, String 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.
    `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
    Constructor and Description
    `FieldInfos(FieldInfo[] infos)` Constructs a new FieldInfos from an array of FieldInfo objects

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