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

Interface PojoIndexingPlan

public interface PojoIndexingPlan

An interface for indexing entities in the context of a session in a POJO mapper.

This class is stateful: it queues operations internally to apply them at a later time.

When process() is called, the entities will be processed and index documents will be built and stored in an internal buffer.

When executeAndReport(EntityReferenceFactory) is called, the operations will be actually sent to the index.

Note that executeAndReport(EntityReferenceFactory) will implicitly trigger processing of documents that weren't processed yet, if any, so calling process() is not necessary if you call executeAndReport(EntityReferenceFactory) just next.

Implementations may not be thread-safe.

Method Summary

Modifier and Type	Method	Description
void	add(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)	Add an entity to the index, assuming that the entity is absent from the index.
void	addOrUpdate(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, boolean forceSelfDirty, boolean forceContainingDirty, BitSet dirtyPaths)	Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.
void	addOrUpdateOrDelete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, boolean forceSelfDirty, boolean forceContainingDirty, BitSet dirtyPaths)	Consider an entity added, updated, or deleted, depending on the result of loading it by ID, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.
void	delete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)	Delete an entity from the index.
void	discard()	Discard all plans of indexing.
void	discardNotProcessed()	Discard all plans of indexing, except for parts that were already processed.
<R> CompletableFuture<MultiEntityOperationExecutionReport<R>>	executeAndReport(EntityReferenceFactory<R> entityReferenceFactory)	Write all pending changes to the index now, without waiting for a Hibernate ORM flush event or transaction commit, and clear the plan so that it can be re-used.
void	process()	Extract all data from objects passed to the indexing plan so far, create documents to be indexed and put them into an internal buffer, without writing them to the indexes.

Method Detail

add

void add(PojoRawTypeIdentifier<?> typeIdentifier,
         Object providedId,
         DocumentRoutesDescriptor providedRoutes,
         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. When in doubt, you should rather use addOrUpdate(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, Object, boolean, boolean, BitSet).

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.

providedRoutes - The route to the current index shard. Only required if custom routing is enabled and the RoutingBridge is missing. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes will be ignored.

entity - The entity to add to the index.

addOrUpdate

void addOrUpdate(PojoRawTypeIdentifier<?> typeIdentifier,
                 Object providedId,
                 DocumentRoutesDescriptor providedRoutes,
                 Object entity,
                 boolean forceSelfDirty,
                 boolean forceContainingDirty,
                 BitSet dirtyPaths)

Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.

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.

providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".

entity - The entity to update in the index.

forceSelfDirty - If true, forces reindexing of this entity regardless of the dirty paths.

forceContainingDirty - If true, forces the resolution of containing entities as dirty

dirtyPaths - The paths to consider dirty, as a BitSet. You can build such a BitSet by obtaining the dirty filter for the entity type and calling one of the filter methods.

delete

void delete(PojoRawTypeIdentifier<?> typeIdentifier,
            Object providedId,
            DocumentRoutesDescriptor providedRoutes,
            Object entity)

Delete an entity from the index.

Entities to reindex as a result of this operation will not be resolved.

No effect on the index if the entity is not in the index.

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 the provided ID is null, Hibernate Search will attempt to extract the ID from the entity (which must be non-null in that case).

providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and entity is null, or the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, and entity is non-null, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".

entity - The entity to delete from the index. May be null if providedId is non-null.

Throws:

IllegalArgumentException - If both providedId and entity are null.

addOrUpdateOrDelete

void addOrUpdateOrDelete(PojoRawTypeIdentifier<?> typeIdentifier,
                         Object providedId,
                         DocumentRoutesDescriptor providedRoutes,
                         boolean forceSelfDirty,
                         boolean forceContainingDirty,
                         BitSet dirtyPaths)

Consider an entity added, updated, or deleted, depending on the result of loading it by ID, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.

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.

providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".

forceSelfDirty - If true, forces reindexing of this entity regardless of the dirty paths.

forceContainingDirty - If true, forces the resolution of containing entities as dirty.

dirtyPaths - The paths to consider dirty, as a BitSet. You can build such a BitSet by obtaining the dirty filter for the entity type and calling one of the filter methods.

process

void process()

Extract all data from objects passed to the indexing plan so far, create documents to be indexed and put them into an internal buffer, without writing them to the indexes.

In particular, ensure that all data is extracted from the POJOs and converted to the backend-specific format.

Calling this method is optional: the executeAndReport(EntityReferenceFactory) method will perform the processing if necessary.

executeAndReport

<R> CompletableFuture<MultiEntityOperationExecutionReport<R>> executeAndReport(EntityReferenceFactory<R> entityReferenceFactory)

Write all pending changes to the index now, without waiting for a Hibernate ORM flush event or transaction commit, and clear the plan so that it can be re-used.

Type Parameters:

R - The type of entity references in the returned execution report.

Parameters:

entityReferenceFactory - A factory for entity references in the returned execution report.

Returns:

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

discard

void discard()

Discard all plans of indexing.

discardNotProcessed

void discardNotProcessed()

Discard all plans of indexing, except for parts that were already processed.