## 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.codecs.lucene40 | Lucene 4.0 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.
  org.apache.lucene.search | Code to search indices.

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

    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.

    Method parameters in org.apache.lucene.codecs with type arguments of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | StoredFieldsWriter.`addDocument(Iterable<? extends IndexableField> doc, FieldInfos fieldInfos)` sugar method for startDocument() + writeField() for every stored field in the document

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

    Methods in org.apache.lucene.codecs.lucene40 with parameters of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene40StoredFieldsWriter.`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` | `ByteDocValuesField` Deprecated. use `NumericDocValuesField` instead.
    `class` | `DerefBytesDocValuesField` Deprecated. Use `BinaryDocValuesField` instead.
    `class` | `DoubleDocValuesField` Syntactic sugar for encoding doubles as NumericDocValues via `Double.doubleToRawLongBits(double)`.
    `class` | `DoubleField` Field that indexes `double` values for efficient range filtering and sorting.
    `class` | `Field` Expert: directly create a field for a document.
    `class` | `FloatDocValuesField` Syntactic sugar for encoding floats as NumericDocValues via `Float.floatToRawIntBits(float)`.
    `class` | `FloatField` Field that indexes `float` values for efficient range filtering and sorting.
    `class` | `IntDocValuesField` Deprecated. use `NumericDocValuesField` instead.
    `class` | `IntField` Field that indexes `int` values for efficient range filtering and sorting.
    `class` | `LongDocValuesField` Deprecated. use `NumericDocValuesField` instead.
    `class` | `LongField` Field that indexes `long` values for efficient range filtering and sorting.
    `class` | `NumericDocValuesField` Field that stores a per-document `long` value for scoring, sorting or value retrieval.
    `class` | `PackedLongDocValuesField` Deprecated. use `NumericDocValuesField` instead.
    `class` | `ShortDocValuesField` Deprecated. use `NumericDocValuesField` instead.
    `class` | `SortedBytesDocValuesField` Deprecated. Use `SortedDocValuesField` instead.
    `class` | `SortedDocValuesField` Field that stores a per-document `BytesRef` value, indexed for sorting.
    `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(int, org.apache.lucene.index.StoredFieldVisitor)` will return the field and its value.
    `class` | `StraightBytesDocValuesField` Deprecated. Use `BinaryDocValuesField` instead.
    `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.

    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
    --- | ---
    `void` | IndexWriter.`addDocument(Iterable<? extends IndexableField> doc)` Adds a document to this index.
    `void` | IndexWriter.`addDocument(Iterable<? extends IndexableField> doc, Analyzer analyzer)` Adds a document to this index, using the provided analyzer instead of the value of `IndexWriter.getAnalyzer()`.
    `void` | 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.
    `void` | IndexWriter.`addDocuments(Iterable<? extends Iterable<? extends IndexableField>> docs, Analyzer analyzer)` Atomically adds a block of documents, analyzed using the provided analyzer, with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
    `void` | 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.
    `void` | IndexWriter.`updateDocument(Term term, Iterable<? extends IndexableField> doc, Analyzer analyzer)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
    `void` | 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.
    `void` | IndexWriter.`updateDocuments(Term delTerm, Iterable<? extends Iterable<? extends IndexableField>> docs, Analyzer analyzer)` Atomically deletes documents matching the provided delTerm and adds a block of documents, analyzed using the provided analyzer, with sequentially assigned document IDs, such that an external reader will see all or none of the documents.

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

    Method parameters in org.apache.lucene.search with type arguments of type IndexableField
    Modifier and Type | Method and Description
    --- | ---
    `long` | NRTManager.TrackingIndexWriter.`addDocument(Iterable<? extends IndexableField> d)`
    `long` | NRTManager.TrackingIndexWriter.`addDocument(Iterable<? extends IndexableField> d, Analyzer a)`
    `long` | NRTManager.TrackingIndexWriter.`addDocuments(Iterable<? extends Iterable<? extends IndexableField>> docs)`
    `long` | NRTManager.TrackingIndexWriter.`addDocuments(Iterable<? extends Iterable<? extends IndexableField>> docs, Analyzer a)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocument(Term t, Iterable<? extends IndexableField> d)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocument(Term t, Iterable<? extends IndexableField> d, Analyzer a)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocuments(Term t, Iterable<? extends Iterable<? extends IndexableField>> docs)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocuments(Term t, Iterable<? extends Iterable<? extends IndexableField>> docs, Analyzer a)`

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