## Uses of Interface
org.apache.lucene.index.IndexableField

- Packages that use IndexableField
  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.document | The logical representation of a `Document` for indexing and searching.
  org.apache.lucene.index | Code to maintain and access indices.

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

    Classes in org.apache.lucene.codecs that implement IndexableField
    Modifier and Type | Class and Description
    --- | ---
    `protected class` | `StoredFieldsWriter.MergeVisitor` A visitor that adds every field it sees.

    Methods in org.apache.lucene.codecs with parameters of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | StoredFieldsWriter.`writeField(FieldInfo info, IndexableField field)` Writes a single stored field.

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

    Methods in org.apache.lucene.codecs.compressing with parameters of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompressingStoredFieldsWriter.`writeField(FieldInfo info, IndexableField field)`

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

    Classes in org.apache.lucene.document that implement IndexableField
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BinaryDocValuesField` Field that stores a per-document `BytesRef` value.
    `class` | `BinaryPoint` An indexed binary field for fast range filters.
    `class` | `DoubleDocValuesField` Syntactic sugar for encoding doubles as NumericDocValues via `Double.doubleToRawLongBits(double)`.
    `class` | `DoublePoint` An indexed `double` field for fast range filters.
    `class` | `DoubleRange` An indexed Double Range field.
    `class` | `DoubleRangeDocValuesField` DocValues field for DoubleRange.
    `class` | `FeatureField` `Field` that can be used to store static scoring factors into documents.
    `class` | `Field` Expert: directly create a field for a document.
    `class` | `FloatDocValuesField` Syntactic sugar for encoding floats as NumericDocValues via `Float.floatToRawIntBits(float)`.
    `class` | `FloatPoint` An indexed `float` field for fast range filters.
    `class` | `FloatRange` An indexed Float Range field.
    `class` | `FloatRangeDocValuesField` DocValues field for FloatRange.
    `class` | `IntPoint` An indexed `int` field for fast range filters.
    `class` | `IntRange` An indexed Integer Range field.
    `class` | `IntRangeDocValuesField` DocValues field for IntRange.
    `class` | `LatLonDocValuesField` An per-document location field.
    `class` | `LatLonPoint` An indexed location field.
    `class` | `LongPoint` An indexed `long` field for fast range filters.
    `class` | `LongRange` An indexed Long Range field.
    `class` | `LongRangeDocValuesField` DocValues field for LongRange.
    `class` | `NumericDocValuesField` Field that stores a per-document `long` value for scoring, sorting or value retrieval.
    `static class` | `ShapeField.Triangle` polygons are decomposed into tessellated triangles using `Tessellator` these triangles are encoded and inserted as separate indexed POINT fields
    `class` | `SortedDocValuesField` Field that stores a per-document `BytesRef` value, indexed for sorting.
    `class` | `SortedNumericDocValuesField` Field that stores a per-document `long` values for scoring, sorting or value retrieval.
    `class` | `SortedSetDocValuesField` Field that stores a set of per-document `BytesRef` values, indexed for faceting,grouping,joining.
    `class` | `StoredField` A field whose value is stored so that `IndexSearcher.doc(int)` and `IndexReader.document()` will return the field and its value.
    `class` | `StringField` A field that is indexed but not tokenized: the entire String value is indexed as a single token.
    `class` | `TextField` A field that is indexed and tokenized, without term vectors.
    `class` | `XYDocValuesField` An per-document location field.
    `class` | `XYPointField` An indexed XY position field.

    Methods in org.apache.lucene.document that return IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `IndexableField` | Document.`getField(String name)` Returns a field with the given name if any exist in this document, or null.
    `IndexableField[]` | Document.`getFields(String name)` Returns an array of `IndexableField`s with the given name.

    Methods in org.apache.lucene.document that return types with arguments of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `List<IndexableField>` | Document.`getFields()` Returns a List of all the fields in a document.
    `Iterator<IndexableField>` | Document.`iterator()`

    Methods in org.apache.lucene.document with parameters of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `void` | Document.`add(IndexableField field)` Adds a field to a document.

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

    Method parameters in org.apache.lucene.index with type arguments of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `long` | IndexWriter.`addDocument(Iterable<? extends IndexableField> doc)` Adds a document to this index.
    `long` | IndexWriter.`addDocuments(Iterable<? extends Iterable<? extends IndexableField>> docs)` Atomically adds a block of documents with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
    `long` | IndexWriter.`softUpdateDocument(Term term, Iterable<? extends IndexableField> doc, Field... softDeletes)` Expert: Updates a document by first updating the document(s) containing `term` with the given doc-values fields and then adding the new document.
    `long` | IndexWriter.`softUpdateDocuments(Term term, Iterable<? extends Iterable<? extends IndexableField>> docs, Field... softDeletes)` Expert: Atomically updates documents matching the provided term with the given doc-values fields and adds a block of documents with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
    `long` | IndexWriter.`updateDocument(Term term, Iterable<? extends IndexableField> doc)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
    `long` | IndexWriter.`updateDocuments(Term delTerm, Iterable<? extends Iterable<? extends IndexableField>> docs)` Atomically deletes documents matching the provided delTerm and adds a block of documents with sequentially assigned document IDs, such that an external reader will see all or none of the documents.

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