Uses of Class
org.hibernate.search.mapper.pojo.route.DocumentRoutesDescriptor

Packages that use DocumentRoutesDescriptor

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

Uses of DocumentRoutesDescriptor in org.hibernate.search.mapper.pojo.route

Methods in org.hibernate.search.mapper.pojo.route that return DocumentRoutesDescriptor

Modifier and Type	Method	Description
static DocumentRoutesDescriptor	DocumentRoutesDescriptor.fromLegacyRoutingKey(String providedRoutingKey)	A util to convert the legacy representation of a route (a single string) to a DocumentRoutesDescriptor.
static DocumentRoutesDescriptor	DocumentRoutesDescriptor.of(DocumentRouteDescriptor currentRoute)
static DocumentRoutesDescriptor	DocumentRoutesDescriptor.of(DocumentRouteDescriptor currentRoute, Collection<DocumentRouteDescriptor> previousRoutes)

Uses of DocumentRoutesDescriptor in org.hibernate.search.mapper.pojo.work.spi

Fields in org.hibernate.search.mapper.pojo.work.spi declared as DocumentRoutesDescriptor

Modifier and Type	Field	Description
final DocumentRoutesDescriptor	PojoIndexingQueueEventPayload.routes

Methods in org.hibernate.search.mapper.pojo.work.spi with parameters of type DocumentRoutesDescriptor

Modifier and Type	Method	Description
default CompletableFuture<?>	PojoIndexer.add(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy)	Deprecated. Use PojoIndexer.add(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
CompletableFuture<?>	PojoIndexer.add(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy, org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)	Add an entity to the index, assuming that the entity is absent from the index.
void	PojoIndexingPlan.add(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)	Deprecated. Use typeIfIncludedOrNull(typeIdentifier) instead, then (if non-null) .add(...) on the result.
void	PojoTypeIndexingPlan.add(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)	Add an entity to the index, assuming that the entity is absent from the index.
default CompletableFuture<?>	PojoIndexer.addOrUpdate(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy)	Deprecated. Use PojoIndexer.addOrUpdate(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
CompletableFuture<?>	PojoIndexer.addOrUpdate(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy, org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)	Update an entity in the index, or add it if it's absent from the index.
void	PojoIndexingPlan.addOrUpdate(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, boolean forceSelfDirty, boolean forceContainingDirty, BitSet dirtyPaths)	Deprecated. Use typeIfIncludedOrNull(typeIdentifier) instead, then (if non-null) .addOrUpdate(...) on the result.
void	PojoTypeIndexingPlan.addOrUpdate(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	PojoIndexingPlan.addOrUpdateOrDelete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, boolean forceSelfDirty, boolean forceContainingDirty, BitSet dirtyPaths)	Deprecated. Use typeIfIncludedOrNull(typeIdentifier) instead, then (if non-null) .addOrUpdateOrDelete(...) on the result.
void	PojoTypeIndexingPlan.addOrUpdateOrDelete(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.
default CompletableFuture<?>	PojoIndexer.delete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy)	Deprecated. Use PojoIndexer.delete(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
CompletableFuture<?>	PojoIndexer.delete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy, org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)	Delete an entity from the index.
default CompletableFuture<?>	PojoIndexer.delete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy)	Deprecated. Use PojoIndexer.delete(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
CompletableFuture<?>	PojoIndexer.delete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy, org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)	Purge an entity from the index.
void	PojoIndexingPlan.delete(PojoRawTypeIdentifier<?> typeIdentifier, Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)	Deprecated. Use typeIfIncludedOrNull(typeIdentifier) instead, then (if non-null) .delete(...) on the result.
void	PojoTypeIndexingPlan.delete(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)	Delete an entity from the index.

Constructors in org.hibernate.search.mapper.pojo.work.spi with parameters of type DocumentRoutesDescriptor

Modifier	Constructor	Description
	PojoIndexingQueueEventPayload(DocumentRoutesDescriptor routes, DirtinessDescriptor dirtiness)