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 and Description
void	addIndexed(MappableTypeModel typeModel, IndexManagerBuildingState<?> indexManagerBuildingState) Add an indexed type to the mapping that will be built.
void	closeOnFailure() Close any allocated resource.
MPBS	prepareBuild() Partially build the mapping based on the indexed types added so far.

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

addIndexed

void addIndexed(MappableTypeModel typeModel,
                IndexManagerBuildingState<?> indexManagerBuildingState)

Add an indexed type to the mapping that will be built.

Never called after prepareBuild().

Parameters:

typeModel - A model of the type to be mapped

indexManagerBuildingState - The building state for the index to be mapped

prepareBuild

MPBS prepareBuild()
           throws MappingAbortedException

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

May only be called once on a given object.

The

Returns:

The partially-built mapping.

Throws:

MappingAbortedException - When aborting the mapping due to collected failures.