Package org.hibernate.search.engine.mapper.mapping.building.spi

Interface Mapper<MPBS extends MappingPartialBuildState>

Type Parameters:

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

public interface Mapper<MPBS extends MappingPartialBuildState>

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.

Method Details

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

prepareMappedTypes

void prepareMappedTypes(BackendsInfo backendsInfo)

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 mapTypes(MappedIndexManagerFactory).

Parameters:

backendsInfo - A collector of backend names and other info.

mapTypes

void mapTypes(MappedIndexManagerFactory indexManagerFactory)

Begin the creation of a mapping for all mapped types.

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

Parameters:

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

prepareBuild

MPBS prepareBuild()
           throws MappingAbortedException

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

Called exactly once just after mapTypes(MappedIndexManagerFactory).

Returns:

The partially-built mapping.

Throws:

MappingAbortedException - When aborting the mapping due to collected failures.