Package org.hibernate.search.engine.backend.document.model.dsl.spi

Interface IndexRootBuilder

All Superinterfaces:
IndexCompositeNodeBuilder, IndexSchemaBuildContext
public interface IndexRootBuilder extends IndexCompositeNodeBuilder

  • Method Details

    • createTypeFactory

      IndexFieldTypeFactory createTypeFactory(IndexFieldTypeDefaultsProvider defaultsProvider)

    • explicitRouting

      void explicitRouting()
      Inform the model collector that documents will always be provided along with an explicit routing key, to be used to route the document to a specific shard.

    • idDslConverter

      <I> void idDslConverter(Class<I> valueType, ToDocumentValueConverter<I,String> converter)
      Defines how identifier values passed to the search DSL should be converted to document identifiers when using ValueModel.MAPPING.
      Type Parameters:
      I - The type of identifier values that can be passed to the DSL.
      Parameters:
      valueType - The type of values that can be passed to the DSL.
      converter - A converter from the given value type to the document identifier (a string).

    • idParser

      void idParser(ToDocumentValueConverter<String,String> converter)
      Defines how identifier values passed to the search DSL should be converted to document identifiers when using ValueModel.STRING.
      Parameters:
      converter - A converter from the string value type to the document identifier (a string).

    • idProjectionConverter

      <I> void idProjectionConverter(Class<I> valueType, FromDocumentValueConverter<String,I> converter)
      Define how values returned when projecting on identifiers should be converted before being returned to the user.

      When not set, users will be returned the document identifier directly.

      Type Parameters:
      I - The type of values that will be returned when projecting on identifiers.
      Parameters:
      valueType - The type of values that will be returned when projecting on fields of this type.
      converter - A converter from the document identifier (a string) to the given value type.