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	closeOnFailure() Close any allocated resource.
void	mapIndexedTypes(IndexManagerBuildingStateProvider indexManagerBuildingStateProvider) Begin the creation of a mapping for all indexed types.
MPBS	prepareBuild() Partially build the mapping based on the indexex types added so far.
void	prepareIndexedTypes(Consumer<Optional<String>> backendNameCollector) Prepare for the mapping of indexed types and inform the engine of the names of all backends this mapper depends on.

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.

prepareIndexedTypes

void prepareIndexedTypes(Consumer<Optional<String>> backendNameCollector)

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

Called exactly once just before mapIndexedTypes(IndexManagerBuildingStateProvider).

Parameters:

backendNameCollector - A collector of backend names, Optional.empty() means "the default backend".

mapIndexedTypes

void mapIndexedTypes(IndexManagerBuildingStateProvider indexManagerBuildingStateProvider)

Begin the creation of a mapping for all indexed types.

Called exactly once just after prepareIndexedTypes(Consumer) and before prepareBuild().

Parameters:

indexManagerBuildingStateProvider - A provider of index manager building states, supporting all the backends declared in prepareIndexedTypes(Consumer).

prepareBuild

MPBS prepareBuild()
           throws MappingAbortedException

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

Called exactly once just after mapIndexedTypes(IndexManagerBuildingStateProvider).

Returns:

The partially-built mapping.

Throws:

MappingAbortedException - When aborting the mapping due to collected failures.