Package org.hibernate.search.mapper.pojo.mapping.building.impl

Class PojoMapper<MPBS extends MappingPartialBuildState>

java.lang.Object

org.hibernate.search.mapper.pojo.mapping.building.impl.PojoMapper<MPBS>

All Implemented Interfaces:

Mapper<MPBS>

public class PojoMapper<MPBS extends MappingPartialBuildState>
extends Object
implements Mapper<MPBS>

Constructor Summary

Constructors

Constructor

Description

PojoMapper(MappingBuildContext buildContext, TypeMetadataContributorProvider<PojoTypeMetadataContributor> contributorProvider, PojoBootstrapIntrospector introspector, ContainerExtractorBinder extractorBinder, BridgeResolver bridgeResolver, BeanReference<? extends IdentifierBridge<Object>> providedIdentifierBridge, IdentityMappingMode containedEntityIdentityMappingMode, TenancyMode tenancyMode, ReindexOnUpdate defaultReindexOnUpdate, PojoMapperDelegate<MPBS> delegate)

Method Summary

Modifier and Type	Method	Description
void	closeOnFailure()	Close any allocated resource.
void	mapTypes(MappedIndexManagerFactory indexManagerFactory)	Begin the creation of a mapping for all mapped types.
MPBS	prepareBuild()	Partially build the mapping based on the indexed types added so far.
void	prepareMappedTypes(BackendsInfo backendsInfo)	Prepare for the mapping of types and inform the engine of the names of all backends this mapper depends on.

Methods inherited from class java.lang.Object

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

Constructor Details

PojoMapper

public PojoMapper(MappingBuildContext buildContext,
 TypeMetadataContributorProvider<PojoTypeMetadataContributor> contributorProvider,
 PojoBootstrapIntrospector introspector,
 ContainerExtractorBinder extractorBinder,
 BridgeResolver bridgeResolver,
 BeanReference<? extends IdentifierBridge<Object>> providedIdentifierBridge,
 IdentityMappingMode containedEntityIdentityMappingMode,
 TenancyMode tenancyMode,
 ReindexOnUpdate defaultReindexOnUpdate,
 PojoMapperDelegate<MPBS> delegate)

Method Details

closeOnFailure

public void closeOnFailure()

Description copied from interface: Mapper

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 the mapper.

Specified by:

closeOnFailure in interface Mapper<MPBS extends MappingPartialBuildState>

prepareMappedTypes

public void prepareMappedTypes(BackendsInfo backendsInfo)

Description copied from interface: Mapper

Prepare for the mapping of types and inform the engine of the names of all backends this mapper depends on.

Called exactly once just before Mapper.mapTypes(MappedIndexManagerFactory).

Specified by:

prepareMappedTypes in interface Mapper<MPBS extends MappingPartialBuildState>

Parameters:

backendsInfo - A collector of backend names and other info.

mapTypes

public void mapTypes(MappedIndexManagerFactory indexManagerFactory)

Description copied from interface: Mapper

Begin the creation of a mapping for all mapped types.

Called exactly once just after Mapper.prepareMappedTypes(BackendsInfo) and before Mapper.prepareBuild().

Specified by:

mapTypes in interface Mapper<MPBS extends MappingPartialBuildState>

Parameters:

indexManagerFactory - A factory for index managers, supporting all the backends declared in Mapper.prepareMappedTypes(BackendsInfo).

prepareBuild

public MPBS prepareBuild()
                  throws MappingAbortedException

Description copied from interface: Mapper

Partially build the mapping based on the indexed types added so far.

Called exactly once just after Mapper.mapTypes(MappedIndexManagerFactory).

Specified by:

prepareBuild in interface Mapper<MPBS extends MappingPartialBuildState>

Returns:

The partially-built mapping.

Throws:

MappingAbortedException - If something went wrong when preparing the mapping.