org.hibernate.search.elasticsearch.schema.impl

## Interface ElasticsearchSchemaTranslator

- All Known Implementing Classes:
    Elasticsearch2SchemaTranslator, Elasticsearch50SchemaTranslator, Elasticsearch52SchemaTranslator

      public interface ElasticsearchSchemaTranslator

  An object responsible for translating a Hibernate Search schema to an Elasticsearch schema.
  Author:
    Yoann Rodiere

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `isTextDataType(PartialDocumentFieldMetadata fieldMetadata)`
    `IndexMetadata` | `translate(URLEncodedString indexName, Collection<EntityIndexBinding> descriptors, ExecutionOptions executionOptions)` Translates index metadata, throwing an exception if translation fails.

- - ### Method Detail

    - #### translate

          IndexMetadata translate(URLEncodedString indexName,
                                  Collection<EntityIndexBinding> descriptors,
                                  ExecutionOptions executionOptions)

      Translates index metadata, throwing an exception if translation fails.
      Parameters:
        `indexName` - The name of the index
        `descriptors` - The entity bindings
        `executionOptions` - The execution options, giving more context information.
      Throws:
        `SearchException` - If an error occurs.

    - #### isTextDataType

          boolean isTextDataType(PartialDocumentFieldMetadata fieldMetadata)

      Parameters:
        `fieldMetadata` - Metadata to inspect
      Returns:
        `true` if the given field will have the "text" datatype on Elasticsearch, `false` otherwise.

Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved