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)
EntityReferenceFactory	createEntityReferenceFactory(PojoEntityReferenceFactoryDelegate delegate)
PojoIndexingQueueEventProcessingPlan	createEventProcessingPlan(PojoWorkSessionContext context, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy, PojoIndexingQueueEventSendingPlan sendingPlan)
PojoIndexer	createIndexer(PojoWorkSessionContext context)
PojoIndexingPlan	createIndexingPlan(PojoWorkSessionContext context, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
PojoIndexingPlan	createIndexingPlan(PojoWorkSessionContext context, PojoIndexingQueueEventSendingPlan sendingPlan)
<SR, R extends EntityReference, C> Optional<PojoScopeDelegate<SR,R,Object,C>>	createPojoAllScope(PojoScopeMappingContext mappingContext, Class<SR> rootScope, PojoScopeTypeExtendedContextProvider<Object,C> indexedTypeExtendedContextProvider)
<SR, R extends EntityReference, E, C> PojoScopeDelegate<SR,R,E,C>	createPojoScope(PojoScopeMappingContext mappingContext, Class<SR> rootScope, Collection<? extends PojoRawTypeIdentifier<? extends E>> targetedTypes, PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)	Deprecated. Use createPojoScopeForClasses(PojoScopeMappingContext, Class, Collection, PojoScopeTypeExtendedContextProvider) or createPojoScopeForEntityNames(PojoScopeMappingContext, Class, Class, Collection, PojoScopeTypeExtendedContextProvider) or createPojoAllScope(PojoScopeMappingContext, Class, PojoScopeTypeExtendedContextProvider) instead.
<SR, R extends EntityReference, E, C> PojoScopeDelegate<SR,R,E,C>	createPojoScopeForClasses(PojoScopeMappingContext mappingContext, Class<SR> rootScope, 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.
<SR, R extends EntityReference, E, C> PojoScopeDelegate<SR,R,E,C>	createPojoScopeForEntityNames(PojoScopeMappingContext mappingContext, Class<SR> rootScope, 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.
FailureHandler	failureHandler()
ProjectionMappedTypeContext	mappedTypeContext(String name)
ProjectionRegistry	projectionRegistry()
TenancyMode	tenancyMode()
ThreadPoolProvider	threadPoolProvider()
PojoLoadingTypeContextProvider	typeContextProvider()
PojoRawTypeIdentifierResolver	typeIdentifierResolver()

Method Details

close

void close()

Specified by:

close in interface AutoCloseable

threadPoolProvider

ThreadPoolProvider threadPoolProvider()

failureHandler

FailureHandler failureHandler()

typeIdentifierResolver

PojoRawTypeIdentifierResolver typeIdentifierResolver()

typeContextProvider

PojoLoadingTypeContextProvider typeContextProvider()

tenancyMode

TenancyMode tenancyMode()

projectionRegistry

ProjectionRegistry projectionRegistry()

mappedTypeContext

ProjectionMappedTypeContext mappedTypeContext(String name)

createEntityReferenceFactory

EntityReferenceFactory createEntityReferenceFactory(PojoEntityReferenceFactoryDelegate delegate)

createPojoScopeForClasses

<SR,
R extends EntityReference,
E,
C>
PojoScopeDelegate<SR,R,E,C> createPojoScopeForClasses(PojoScopeMappingContext mappingContext,
 Class<SR> rootScope,
 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:

SR - Scope root type.

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.

rootScope - A class representig the SR.

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

<SR,
R extends EntityReference,
E,
C>
PojoScopeDelegate<SR,R,E,C> createPojoScopeForEntityNames(PojoScopeMappingContext mappingContext,
 Class<SR> rootScope,
 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:

SR - Scope root type.

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(since="7.1")
<SR,
R extends EntityReference,
E,
C>
PojoScopeDelegate<SR,R,E,C> createPojoScope(PojoScopeMappingContext mappingContext,
 Class<SR> rootScope,
 Collection<? extends PojoRawTypeIdentifier<? extends E>> targetedTypes,
 PojoScopeTypeExtendedContextProvider<E,C> indexedTypeExtendedContextProvider)

Deprecated.

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

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

Type Parameters:

SR - Scope root type.

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

<SR,
R extends EntityReference,
C>
Optional<PojoScopeDelegate<SR,R,Object,C>> createPojoAllScope(PojoScopeMappingContext mappingContext,
 Class<SR> rootScope,
 PojoScopeTypeExtendedContextProvider<Object,C> indexedTypeExtendedContextProvider)

createIndexingPlan

PojoIndexingPlan createIndexingPlan(PojoWorkSessionContext context,
 DocumentCommitStrategy commitStrategy,
 DocumentRefreshStrategy refreshStrategy)

createIndexingPlan

PojoIndexingPlan createIndexingPlan(PojoWorkSessionContext context,
 PojoIndexingQueueEventSendingPlan sendingPlan)

createEventProcessingPlan

PojoIndexingQueueEventProcessingPlan createEventProcessingPlan(PojoWorkSessionContext context,
 DocumentCommitStrategy commitStrategy,
 DocumentRefreshStrategy refreshStrategy,
 PojoIndexingQueueEventSendingPlan sendingPlan)

createIndexer

PojoIndexer createIndexer(PojoWorkSessionContext context)

configuredSearchIndexingPlanFilter

ConfiguredSearchIndexingPlanFilter configuredSearchIndexingPlanFilter(SearchIndexingPlanFilter filter,
 ConfiguredSearchIndexingPlanFilter fallback)