org.hibernate.search.mapper.pojo.work.spi

Interface PojoIndexer

public interface PojoIndexer

An interface for indexing entities in the context of a session in a POJO mapper, immediately, asynchronously and without any sort of planning.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<?>	add(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, Object entity) Add an entity to the index, assuming that the entity is absent from the index.

Method Detail

add

CompletableFuture<?> add(PojoRawTypeIdentifier<?> typeIdentifier,
                         Object providedId,
                         Object entity)

Add an entity to the index, assuming that the entity is absent from the index.

Note: depending on the backend, this may lead to errors or duplicate entries in the index if the entity was actually already present in the index before this call.

Parameters:

typeIdentifier - The identifier of the entity type.

providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping. If null, Hibernate Search will attempt to extract the ID from the entity.

entity - The entity to add to the index.

Returns:

A CompletableFuture reflecting the completion state of the operation.