Package org.hibernate.search.backend.elasticsearch.mapping.impl

Class IndexNameTypeNameMapping

java.lang.Object

org.hibernate.search.backend.elasticsearch.mapping.impl.IndexNameTypeNameMapping

All Implemented Interfaces:

TypeNameMapping

public class IndexNameTypeNameMapping
extends Object
implements TypeNameMapping

Rely on the "_index" meta-field to resolve the type name. Does not work with index aliases.

Constructor Summary

Constructors

Constructor	Description
IndexNameTypeNameMapping(IndexLayoutStrategy indexLayoutStrategy)

Method Summary

Modifier and Type	Method	Description
Optional<DocumentMetadataContributor>	getDocumentMetadataContributor(String mappedTypeName)
Optional<ImplicitFieldContributor>	getImplicitFieldContributor()
Optional<IndexSchemaRootContributor>	getIndexSchemaRootContributor()
ProjectionExtractionHelper<String>	getTypeNameExtractionHelper()
void	register(IndexNames indexNames, String mappedTypeName)	Register a new index => type mapping.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexNameTypeNameMapping

public IndexNameTypeNameMapping(IndexLayoutStrategy indexLayoutStrategy)

Method Detail

getIndexSchemaRootContributor

public Optional<IndexSchemaRootContributor> getIndexSchemaRootContributor()

Specified by:

getIndexSchemaRootContributor in interface TypeNameMapping

Returns:

A schema contributor for the required additional properties (type name, ...), or an empty optional.

getDocumentMetadataContributor

public Optional<DocumentMetadataContributor> getDocumentMetadataContributor(String mappedTypeName)

Specified by:

getDocumentMetadataContributor in interface TypeNameMapping

Parameters:

mappedTypeName - The name of the type mapped to the index.

Returns:

A document metadata contributor for the required additional properties (type name, ...), or an empty optional.

getImplicitFieldContributor

public Optional<ImplicitFieldContributor> getImplicitFieldContributor()

Specified by:

getImplicitFieldContributor in interface TypeNameMapping

Returns:

A field contributor for the additional implicit properties (_entity_type, ...), or an empty optional.

register

public void register(IndexNames indexNames,
                     String mappedTypeName)

Description copied from interface: TypeNameMapping

Register a new index => type mapping.

Specified by:

register in interface TypeNameMapping

Parameters:

indexNames - The names of the index.

mappedTypeName - The name of the type mapped to the index.

getTypeNameExtractionHelper

public ProjectionExtractionHelper<String> getTypeNameExtractionHelper()

Specified by:

getTypeNameExtractionHelper in interface TypeNameMapping

Returns:

A helper for projections that need to extract the mapped type name from search hits.