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

Interface PojoSessionWorkExecutor

public interface PojoSessionWorkExecutor

Method Summary

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

Method Detail

add

CompletableFuture<?> add(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:

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.

add

CompletableFuture<?> add(Object entity)

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

Shorthand for add(null, entity); see add(Object, Object).

Parameters:

entity - The entity to add to the index.

Returns:

A CompletableFuture reflecting the completion state of the operation.