Package org.hibernate.search.mapper.orm.automaticindexing.spi

Interface AutomaticIndexingQueueEventProcessingPlan

All Known Implementing Classes:

AutomaticIndexingQueueEventProcessingPlanImpl

public interface AutomaticIndexingQueueEventProcessingPlan

Method Summary

Modifier and Type	Method	Description
void	append(String entityName, String serializedId, PojoIndexingQueueEventPayload payload)	Appends an event to the plan, received from a AutomaticIndexingQueueEventSendingPlan.
CompletableFuture<MultiEntityOperationExecutionReport>	executeAndReport(OperationSubmitter operationSubmitter)	Writes all pending changes to the index now, and clears the plan so that it can be re-used.
Object	toIdentifier(String entityName, String serializedId)	Convert the serialized id to the original identifier.
String	toSerializedId(String entityName, Object identifier)	Convert the identifier to its serialized form.

Method Detail

append

void append(String entityName,
            String serializedId,
            PojoIndexingQueueEventPayload payload)

Appends an event to the plan, received from a AutomaticIndexingQueueEventSendingPlan.

Parameters:

entityName - The name of the entity type.

serializedId - The serialized entity identifier.

payload - The payload as passed to the sending plan.

See Also:

AutomaticIndexingQueueEventSendingPlan.append(String, Object, String, PojoIndexingQueueEventPayload)

executeAndReport

CompletableFuture<MultiEntityOperationExecutionReport> executeAndReport(OperationSubmitter operationSubmitter)

Writes all pending changes to the index now, and clears the plan so that it can be re-used.

Parameters:

operationSubmitter - How to handle request to submit operation when the queue is full.

Returns:

A CompletableFuture that will be completed with an execution report when all the works are complete.

toSerializedId

String toSerializedId(String entityName,
                      Object identifier)

Convert the identifier to its serialized form. The identifier type must be the one used by the entity having name entityName.

Parameters:

entityName - The name of the entity.

identifier - The provided identifier.

Returns:

The serialized for of the provided identifier.

toIdentifier

Object toIdentifier(String entityName,
                    String serializedId)

Convert the serialized id to the original identifier.

Parameters:

entityName - The name of the entity.

serializedId - The serialized id.

Returns:

The original entity identifier.