LuceneSerializer (Apache Geode 1.13.3)
Date: 2021-06-22

org.apache.geode.cache.lucene

## Interface LuceneSerializer<T>

- Type Parameters:
    `T` - The type of object supported by this lucene serializer
  All Superinterfaces:
    Declarable
  All Known Implementing Classes:
    FlatFormatSerializer

      public interface LuceneSerializer<T>
      extends Declarable

  An interface for writing the fields of an object into a lucene document

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Collection<org.apache.lucene.document.Document>` | `toDocuments(LuceneIndex index, T value)` Add the fields of the given value to a set of documents Added fields should be marked with `Field.Store.NO`.

    - ### Methods inherited from interface org.apache.geode.cache.Declarable

      `init, initialize`

- - ### Method Detail

    - #### toDocuments

          Collection<org.apache.lucene.document.Document> toDocuments(LuceneIndex index,
                                                                      T value)

      Add the fields of the given value to a set of documents Added fields should be marked with `Field.Store.NO`. These fields are only used for searches. When doing a query, geode will return the value from the region, not any fields that are stored on the returned Documents.
      Parameters:
        `index` - lucene index
        `value` - user object to be serialized into index