org.hibernate.search.mapper.pojo.mapping.building.spi

Interface PojoMapperDelegate<MPBS>

Type Parameters:

MPBS - The Java type of the partial build state of the produced mapping.

public interface PojoMapperDelegate<MPBS>

A delegate for the POJO mapper, exposing hooks so that mappers based on the POJO mapper can consume metadata.

Method Summary

Modifier and Type	Method and Description
void	closeOnFailure() Close any allocated resource.
<E> PojoContainedTypeExtendedMappingCollector	createContainedTypeExtendedMappingCollector(PojoRawTypeModel<E> rawTypeModel, String entityName)
<E> PojoIndexedTypeExtendedMappingCollector	createIndexedTypeExtendedMappingCollector(PojoRawTypeModel<E> rawTypeModel, String entityName, String indexName)
MPBS	prepareBuild(PojoMappingDelegate mappingDelegate) Partially build the mapping based on the information provided previously.

Method Detail

closeOnFailure

void closeOnFailure()

Close any allocated resource.

This method is called when an error occurs while starting up Hibernate Search. When this method is called, it is guaranteed to be the last call on this object.

createIndexedTypeExtendedMappingCollector

<E> PojoIndexedTypeExtendedMappingCollector createIndexedTypeExtendedMappingCollector(PojoRawTypeModel<E> rawTypeModel,
                                                                                      String entityName,
                                                                                      String indexName)

Type Parameters:

E - The indexed entity type.

Parameters:

rawTypeModel - The raw type model for an indexed entity type, i.e. a type mapped to an index directly.

entityName - The name of the entity type.

indexName - The name of the index mapped to this type.

Returns:

A collector of extended mapping information.

createContainedTypeExtendedMappingCollector

<E> PojoContainedTypeExtendedMappingCollector createContainedTypeExtendedMappingCollector(PojoRawTypeModel<E> rawTypeModel,
                                                                                          String entityName)

Type Parameters:

E - The contained entity type.

Parameters:

rawTypeModel - The raw type model for a contained entity type, i.e. a type mapped to indexes only indirectly by indexed-embedding.

entityName - The name of the entity type.

Returns:

A collector of extended mapping information.

prepareBuild

MPBS prepareBuild(PojoMappingDelegate mappingDelegate)

Partially build the mapping based on the information provided previously.

May only be called once on a given object.

Parameters:

mappingDelegate - A PojoMappingDelegate.

Returns:

The partially-built mapping.