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

- Packages that use Fields
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.codecs.blocktree | BlockTree terms dictionary.
  org.apache.lucene.codecs.compressing | StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
  org.apache.lucene.index | Code to maintain and access indices.

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

    Subclasses of Fields in org.apache.lucene.codecs
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FieldsProducer` Abstract API that produces terms, doc, freq, prox, offset and payloads postings.

    Methods in org.apache.lucene.codecs that return Fields
    Modifier and Type | Method and Description
    --- | ---
    `abstract Fields` | TermVectorsReader.`get(int doc)` Returns term vectors for this document, or null if term vectors were not indexed.

    Methods in org.apache.lucene.codecs with parameters of type Fields
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | TermVectorsWriter.`addAllDocVectors(Fields vectors, MergeState mergeState)` Safe (but, slowish) default method to write every vector field in the document.
    `abstract void` | FieldsConsumer.`write(Fields fields)` Write all fields, terms and postings.

  - ### Uses of Fields in org.apache.lucene.codecs.blocktree

    Subclasses of Fields in org.apache.lucene.codecs.blocktree
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BlockTreeTermsReader` A block-based terms index and dictionary that assigns terms to variable length blocks according to how they share prefixes.

    Methods in org.apache.lucene.codecs.blocktree with parameters of type Fields
    Modifier and Type | Method and Description
    --- | ---
    `void` | BlockTreeTermsWriter.`write(Fields fields)`

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

    Methods in org.apache.lucene.codecs.compressing that return Fields
    Modifier and Type | Method and Description
    --- | ---
    `Fields` | CompressingTermVectorsReader.`get(int doc)`

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

    Subclasses of Fields in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `ExitableDirectoryReader.ExitableFields` Wrapper class for another Fields implementation that is used by the ExitableFilterAtomicReader.
    `static class` | `FilterLeafReader.FilterFields` Base class for filtering `Fields` implementations.
    `class` | `MappedMultiFields` A `Fields` implementation that merges multiple Fields into one, and maps around deleted documents.
    `class` | `MultiFields` Exposes flex API, merged from flex API of sub-segments.

    Fields in org.apache.lucene.index declared as Fields
    Modifier and Type | Field and Description
    --- | ---
    `static Fields[]` | Fields.`EMPTY_ARRAY` Zero-length `Fields` array.
    `protected Fields` | FilterLeafReader.FilterFields.`in` The underlying Fields instance.

    Methods in org.apache.lucene.index that return Fields
    Modifier and Type | Method and Description
    --- | ---
    `Fields` | ParallelLeafReader.`fields()`
    `Fields` | ExitableDirectoryReader.ExitableFilterAtomicReader.`fields()`
    `abstract Fields` | LeafReader.`fields()` Returns `Fields` for this reader.
    `Fields` | CodecReader.`fields()`
    `Fields` | FilterLeafReader.`fields()`
    `static Fields` | MultiFields.`getFields(IndexReader reader)` Returns a single `Fields` instance for this reader, merging fields/terms/docs/positions on the fly.
    `Fields` | ParallelLeafReader.`getTermVectors(int docID)`
    `Fields` | BaseCompositeReader.`getTermVectors(int docID)`
    `Fields` | CodecReader.`getTermVectors(int docID)`
    `abstract Fields` | IndexReader.`getTermVectors(int docID)` Retrieve term vectors for this document, or null if term vectors were not indexed.
    `Fields` | FilterLeafReader.`getTermVectors(int docID)`

    Constructors in org.apache.lucene.index with parameters of type Fields
    Constructor and Description
    `ExitableFields(Fields fields, QueryTimeout queryTimeout)` Constructor
    `FilterFields(Fields in)` Creates a new FilterFields.
    `MultiFields(Fields[] subs, ReaderSlice[] subSlices)` Expert: construct a new MultiFields instance directly.

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