org.hibernate.search.engine.search.loading.spi

Interface ProjectionHitMapper<R,E>

Type Parameters:

R - The type of entity references.

E - The type of entities.

All Known Implementing Classes:

DefaultProjectionHitMapper

public interface ProjectionHitMapper<R,E>

Contract binding result hits and the mapper.

Method Summary

Modifier and Type	Method and Description
R	convertReference(DocumentReference reference) Convert a document reference to the reference specific to the mapper.
LoadingResult<E>	loadBlocking() Loads the entities planned for loading in one go, blocking the current thread while doing so.
Object	planLoading(DocumentReference reference) Plan the loading of an entity.

Method Detail

convertReference

R convertReference(DocumentReference reference)

Convert a document reference to the reference specific to the mapper.

Parameters:

reference - The document reference.

Returns:

The reference specific to the mapper.

planLoading

Object planLoading(DocumentReference reference)

Plan the loading of an entity.

Parameters:

reference - The document reference.

Returns:

The key to use to retrieve the loaded entity from LoadingResult after load.

loadBlocking

LoadingResult<E> loadBlocking()

Loads the entities planned for loading in one go, blocking the current thread while doing so.

Returns:

The loaded entities.