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

Interface PojoMappingDelegate

All Superinterfaces:

AutoCloseable

public interface PojoMappingDelegate
extends AutoCloseable

Method Summary

Modifier and Type	Method	Description
void	close()
ConfiguredSearchIndexingPlanFilter	configuredSearchIndexingPlanFilter(SearchIndexingPlanFilter filter, ConfiguredSearchIndexingPlanFilter fallback)
org.hibernate.search.engine.backend.common.spi.EntityReferenceFactory	createEntityReferenceFactory(PojoEntityReferenceFactoryDelegate delegate)
PojoIndexingQueueEventProcessingPlan	createEventProcessingPlan(PojoWorkSessionContext context, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy, PojoIndexingQueueEventSendingPlan sendingPlan)
PojoIndexer	createIndexer(PojoWorkSessionContext context)
PojoIndexingPlan	createIndexingPlan(PojoWorkSessionContext context, org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy, org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy)
PojoIndexingPlan	createIndexingPlan(PojoWorkSessionContext context, PojoIndexingQueueEventSendingPlan sendingPlan)
<R extends org.hibernate.search.engine.common.EntityReference, C> Optional<PojoScopeDelegate<R,Object,C>>	createPojoAllScope(PojoScopeMappingContext mappingContext, PojoScopeTypeExtendedContextProvider<Object,C> indexedTypeExtendedContextProvider)
<R extends org.hibernate.search.engine.common.EntityReference, E, C> PojoScopeDelegate<R,E,C>	createPojoScope(PojoScopeMappingContext mappingContext, Collection<? extends PojoRawTypeIdentifier<? extends E>> targetedTypes, PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)	Deprecated. Use createPojoScopeForClasses(PojoScopeMappingContext, Collection, PojoScopeTypeExtendedContextProvider) or createPojoScopeForEntityNames(PojoScopeMappingContext, Class, Collection, PojoScopeTypeExtendedContextProvider) or createPojoAllScope(PojoScopeMappingContext, PojoScopeTypeExtendedContextProvider) instead.
<R extends org.hibernate.search.engine.common.EntityReference, E, C> PojoScopeDelegate<R,E,C>	createPojoScopeForClasses(PojoScopeMappingContext mappingContext, Collection<? extends Class<? extends E>> classes, PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)	Creates a PojoScopeDelegate limited to indexed entity types among the given classes and their subtypes.
<R extends org.hibernate.search.engine.common.EntityReference, E, C> PojoScopeDelegate<R,E,C>	createPojoScopeForEntityNames(PojoScopeMappingContext mappingContext, Class<E> expectedSuperType, Collection<String> entityNames, PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)	Creates a PojoScopeDelegate limited to indexed entity types among the entities with the given names and their subtypes.
org.hibernate.search.engine.reporting.FailureHandler	failureHandler()
org.hibernate.search.engine.search.projection.spi.ProjectionMappedTypeContext	mappedTypeContext(String name)
org.hibernate.search.engine.search.projection.definition.spi.ProjectionRegistry	projectionRegistry()
org.hibernate.search.engine.tenancy.spi.TenancyMode	tenancyMode()
org.hibernate.search.engine.environment.thread.spi.ThreadPoolProvider	threadPoolProvider()
PojoLoadingTypeContextProvider	typeContextProvider()
PojoRawTypeIdentifierResolver	typeIdentifierResolver()

Method Details

close

void close()

Specified by:

close in interface AutoCloseable

threadPoolProvider

org.hibernate.search.engine.environment.thread.spi.ThreadPoolProvider threadPoolProvider()

failureHandler

org.hibernate.search.engine.reporting.FailureHandler failureHandler()

typeIdentifierResolver

PojoRawTypeIdentifierResolver typeIdentifierResolver()

typeContextProvider

PojoLoadingTypeContextProvider typeContextProvider()

tenancyMode

org.hibernate.search.engine.tenancy.spi.TenancyMode tenancyMode()

projectionRegistry

org.hibernate.search.engine.search.projection.definition.spi.ProjectionRegistry projectionRegistry()

mappedTypeContext

org.hibernate.search.engine.search.projection.spi.ProjectionMappedTypeContext mappedTypeContext(String name)

createEntityReferenceFactory

org.hibernate.search.engine.backend.common.spi.EntityReferenceFactory createEntityReferenceFactory(PojoEntityReferenceFactoryDelegate delegate)

createPojoScopeForClasses

<R extends org.hibernate.search.engine.common.EntityReference,
E,
C>
PojoScopeDelegate<R,E,C> createPojoScopeForClasses(PojoScopeMappingContext mappingContext,
 Collection<? extends Class<? extends E>> classes,
 PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)

Creates a PojoScopeDelegate limited to indexed entity types among the given classes and their subtypes.

Type Parameters:

R - The type of entity references.

E - A supertype of all indexed entity types to include in the scope.

C - The type of extended, mapper-specific type contexts.

Parameters:

mappingContext - The mapping context.

classes - A collection of classes. Each must be an indexed entity type or a supertype of such type.

indexedTypeExtendedContextProvider - A provider of extended, mapper-specific type contexts. that will be made available through PojoScopeDelegate.includedIndexedTypes().

Returns:

A PojoScopeDelegate

createPojoScopeForEntityNames

<R extends org.hibernate.search.engine.common.EntityReference,
E,
C>
PojoScopeDelegate<R,E,C> createPojoScopeForEntityNames(PojoScopeMappingContext mappingContext,
 Class<E> expectedSuperType,
 Collection<String> entityNames,
 PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)

Creates a PojoScopeDelegate limited to indexed entity types among the entities with the given names and their subtypes.

Type Parameters:

R - The type of entity references.

E - A supertype of all indexed entity types to include in the scope.

C - The type of extended, mapper-specific type contexts.

Parameters:

mappingContext - The mapping context.

expectedSuperType - A supertype of all indexed entity types to include in the scope.

entityNames - A collection of entity names. Each entity type referenced in the collection must be an indexed entity type or a supertype of such type.

indexedTypeExtendedContextProvider - A provider of extended, mapper-specific type contexts. that will be made available through PojoScopeDelegate.includedIndexedTypes().

Returns:

A PojoScopeDelegate

createPojoScope

@Deprecated
<R extends org.hibernate.search.engine.common.EntityReference,
E,
C>
PojoScopeDelegate<R,E,C> createPojoScope(PojoScopeMappingContext mappingContext,
 Collection<? extends PojoRawTypeIdentifier<? extends E>> targetedTypes,
 PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)

Deprecated.

Use createPojoScopeForClasses(PojoScopeMappingContext, Collection, PojoScopeTypeExtendedContextProvider) or createPojoScopeForEntityNames(PojoScopeMappingContext, Class, Collection, PojoScopeTypeExtendedContextProvider) or createPojoAllScope(PojoScopeMappingContext, PojoScopeTypeExtendedContextProvider) instead.

Creates a PojoScopeDelegate limited to indexed entity types among the given types and their subtypes.

Type Parameters:

R - The type of entity references.

E - A supertype of all indexed entity types to include in the scope.

C - The type of extended, mapper-specific type contexts.

Parameters:

mappingContext - The mapping context.

targetedTypes - A collection of types. Each must be an indexed entity type or a supertype of such type.

indexedTypeExtendedContextProvider - A provider of extended, mapper-specific type contexts. that will be made available through PojoScopeDelegate.includedIndexedTypes().

Returns:

A PojoScopeDelegate

createPojoAllScope

<R extends org.hibernate.search.engine.common.EntityReference,
C>
Optional<PojoScopeDelegate<R,Object,C>> createPojoAllScope(PojoScopeMappingContext mappingContext,
 PojoScopeTypeExtendedContextProvider<Object,C> indexedTypeExtendedContextProvider)

createIndexingPlan

PojoIndexingPlan createIndexingPlan(PojoWorkSessionContext context,
 org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy,
 org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy)

createIndexingPlan

PojoIndexingPlan createIndexingPlan(PojoWorkSessionContext context,
 PojoIndexingQueueEventSendingPlan sendingPlan)

createEventProcessingPlan

PojoIndexingQueueEventProcessingPlan createEventProcessingPlan(PojoWorkSessionContext context,
 org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy commitStrategy,
 org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy refreshStrategy,
 PojoIndexingQueueEventSendingPlan sendingPlan)

createIndexer

PojoIndexer createIndexer(PojoWorkSessionContext context)

configuredSearchIndexingPlanFilter

ConfiguredSearchIndexingPlanFilter configuredSearchIndexingPlanFilter(SearchIndexingPlanFilter filter,
 ConfiguredSearchIndexingPlanFilter fallback)