Package org.hibernate.search.mapper.orm.mapping.impl

Class HibernateOrmMapping

java.lang.Object

org.hibernate.search.mapper.pojo.mapping.spi.AbstractPojoMappingImplementor<HibernateOrmMapping>

org.hibernate.search.mapper.orm.mapping.impl.HibernateOrmMapping

All Implemented Interfaces:

AutoCloseable, BackendMappingContext, MappingImplementor<HibernateOrmMapping>, AutomaticIndexingMappingContext, HibernateOrmListenerContextProvider, HibernateOrmLoadingMappingContext, HibernateOrmMappingContext, SearchMapping, CoordinationStrategyContext, HibernateOrmMassIndexingMappingContext, HibernateOrmScopeMappingContext, SearchScopeProvider, HibernateOrmSearchSessionMappingContext, BatchMappingContext, BridgeMappingContext, PojoMassIndexingMappingContext, PojoScopeMappingContext, PojoSearchSessionMappingContext, PojoWorkMappingContext

public class HibernateOrmMapping
extends AbstractPojoMappingImplementor<HibernateOrmMapping>
implements SearchMapping, AutoCloseable, HibernateOrmMappingContext, HibernateOrmListenerContextProvider, BatchMappingContext, HibernateOrmScopeMappingContext, HibernateOrmSearchSessionMappingContext, AutomaticIndexingMappingContext, CoordinationStrategyContext

Method Summary

Modifier and Type	Method	Description
Collection<SearchIndexedEntity<?>>	allIndexedEntities()
ConfiguredSearchIndexingPlanFilter	applicationIndexingPlanFilter()
Backend	backend()
Backend	backend(String backendName)
CompletableFuture<?>	backgroundIndexingCompletion()
EntityLoadingCacheLookupStrategy	cacheLookupStrategy()
void	close()
ConfiguredSearchIndexingPlanFilter	configuredSearchIndexingPlanFilter(SearchIndexingPlanFilter filter)
CoordinationStrategy	coordinationStrategy()
static MappingImplementor<HibernateOrmMapping>	create(PojoMappingDelegate mappingDelegate, org.hibernate.search.mapper.orm.mapping.impl.HibernateOrmTypeContextContainer typeContextContainer, BeanHolder<? extends CoordinationStrategy> coordinationStrategyHolder, ConfiguredAutomaticIndexingStrategy configuredAutomaticIndexingStrategy, SessionFactoryImplementor sessionFactory, ConfigurationPropertySource propertySource)
AutomaticIndexingQueueEventProcessingPlan	createIndexingQueueEventProcessingPlan(Session session)
PojoMassIndexerAgent	createMassIndexerAgent(PojoMassIndexerAgentCreateContext context)	Creates a PojoMassIndexerAgent, able to exert control over other agents that could perform indexing concurrently (e.g. indexing plans).
<T> SearchScopeImpl<T>	createScope(Class<T> expectedSuperType, Collection<String> entityNames)
<T> SearchScopeImpl<T>	createScope(Collection<? extends Class<? extends T>> classes)
HibernateOrmSearchSession.Builder	createSessionBuilder(SessionImplementor sessionImplementor)
ConfiguredIndexingPlanSynchronizationStrategy	currentAutomaticIndexingSynchronizationStrategy(SessionImplementor session)
PojoIndexingPlan	currentIndexingPlanIfExisting(SessionImplementor session)
PojoTypeIndexingPlan	currentIndexingPlanIfTypeIncluded(SessionImplementor session, PojoRawTypeIdentifier<?> typeIdentifier)
protected void	doStop()
int	fetchSize()
BackendMappingHints	hints()
<E> SearchIndexedEntity<E>	indexedEntity(Class<E> entityType)
SearchIndexedEntity<?>	indexedEntity(String entityName)
void	indexingPlanFilter(SearchIndexingPlanFilter filter)	Set a filter defining which types must be included/excluded when indexed within indexing plans (either automatically or manually).
IndexManager	indexManager(String indexName)
boolean	listenerEnabled()
void	listenerEnabled(boolean enabled)
MassIndexingDefaultCleanOperation	massIndexingDefaultCleanOperation()
CompletableFuture<?>	preStop(MappingPreStopContext context)	Prepare for MappingImplementor.stop(), executing any operations that needs to be executed before shutdown.
<T> SearchScopeImpl<T>	scope(Class<T> clazz)	Creates a SearchScope limited to indexed entity types among the given class and its subtypes.
<T> SearchScopeImpl<T>	scope(Class<T> expectedSuperType, String entityName)	Creates a SearchScope limited to indexed entity types among the entity with the given name and its subtypes.
<T> SearchScopeImpl<T>	scope(Class<T> expectedSuperType, Collection<String> entityNames)	Creates a SearchScope limited to indexed entity types among the entities with the given names and their subtypes.
<T> SearchScopeImpl<T>	scope(Collection<? extends Class<? extends T>> classes)	Creates a SearchScope limited to indexed entity types among the given classes and their subtypes.
HibernateOrmScopeSessionContext	sessionContext(EntityManager entityManager)
SessionFactoryImplementor	sessionFactory()
CompletableFuture<?>	start(MappingStartContext context)	Start any resource necessary to operate the mapping at runtime.
TenancyConfiguration	tenancyConfiguration()
HibernateOrmMapping	toConcreteType()
EntityManagerFactory	toEntityManagerFactory()
SessionFactory	toOrmSessionFactory()
org.hibernate.search.mapper.orm.mapping.impl.HibernateOrmTypeContextContainer	typeContextProvider()

Methods inherited from class org.hibernate.search.mapper.pojo.mapping.spi.AbstractPojoMappingImplementor

createIndexer, createIndexingPlan, createIndexingPlan, createIndexingQueueEventProcessingPlan, delegate, entityReferenceFactory, entityReferenceFactoryDelegate, failureHandler, identifierBridgeToDocumentIdentifierContext, mappedTypeContext, projectionRegistry, stop, threadPoolProvider, toDocumentValueConvertContext, typeIdentifierResolver, valueBridgeToIndexedValueContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.mapper.orm.automaticindexing.spi.AutomaticIndexingMappingContext

entityReferenceFactory, failureHandler

Methods inherited from interface org.hibernate.search.engine.backend.mapping.spi.BackendMappingContext

entityReferenceFactory, mappedTypeContext, projectionRegistry, toDocumentValueConvertContext

Methods inherited from interface org.hibernate.search.mapper.pojo.bridge.runtime.spi.BridgeMappingContext

identifierBridgeToDocumentIdentifierContext, valueBridgeToIndexedValueContext

Methods inherited from interface org.hibernate.search.mapper.orm.session.impl.HibernateOrmSearchSessionMappingContext

failureHandler

Methods inherited from interface org.hibernate.search.mapper.pojo.massindexing.spi.PojoMassIndexingMappingContext

entityReferenceFactoryDelegate, threadPoolProvider

Methods inherited from interface org.hibernate.search.mapper.pojo.scope.spi.PojoScopeMappingContext

entityReferenceFactoryDelegate, typeIdentifierResolver

Methods inherited from interface org.hibernate.search.mapper.pojo.session.spi.PojoSearchSessionMappingContext

createIndexer, createIndexingPlan, createIndexingPlan, createIndexingQueueEventProcessingPlan

Methods inherited from interface org.hibernate.search.mapper.orm.mapping.SearchMapping

extension

Method Details

create

public static MappingImplementor<HibernateOrmMapping> create(PojoMappingDelegate mappingDelegate,
 org.hibernate.search.mapper.orm.mapping.impl.HibernateOrmTypeContextContainer typeContextContainer,
 BeanHolder<? extends CoordinationStrategy> coordinationStrategyHolder,
 ConfiguredAutomaticIndexingStrategy configuredAutomaticIndexingStrategy,
 SessionFactoryImplementor sessionFactory,
 ConfigurationPropertySource propertySource)

close

public void close()

Specified by:

close in interface AutoCloseable

start

public CompletableFuture<?> start(MappingStartContext context)

Description copied from interface: MappingImplementor

Start any resource necessary to operate the mapping at runtime.

Called by the engine once during bootstrap, after backends and index managers were started.

Specified by:

start in interface MappingImplementor<HibernateOrmMapping>

Overrides:

start in class AbstractPojoMappingImplementor<HibernateOrmMapping>

Parameters:

context - The start context.

Returns:

A future that completes when the mapper is completely started.

preStop

public CompletableFuture<?> preStop(MappingPreStopContext context)

Description copied from interface: MappingImplementor

Prepare for MappingImplementor.stop(), executing any operations that needs to be executed before shutdown.

Specified by:

preStop in interface MappingImplementor<HibernateOrmMapping>

Overrides:

preStop in class AbstractPojoMappingImplementor<HibernateOrmMapping>

Parameters:

context - The pre-stop context.

Returns:

A future that completes when pre-stop operations complete.

doStop

protected void doStop()

Overrides:

doStop in class AbstractPojoMappingImplementor<HibernateOrmMapping>

hints

public BackendMappingHints hints()

Specified by:

hints in interface BackendMappingContext

Overrides:

hints in class AbstractPojoMappingImplementor<HibernateOrmMapping>

scope

public <T> SearchScopeImpl<T> scope(Class<T> clazz)

Description copied from interface: SearchScopeProvider

Creates a SearchScope limited to indexed entity types among the given class and its subtypes.

Specified by:

scope in interface BatchMappingContext

Specified by:

scope in interface SearchScopeProvider

Type Parameters:

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

Parameters:

clazz - A class that must be an indexed entity type or a supertype of such type.

Returns:

The created scope.

See Also:

• SearchScope

scope

public <T> SearchScopeImpl<T> scope(Class<T> expectedSuperType,
 String entityName)

Description copied from interface: SearchScopeProvider

Creates a SearchScope limited to indexed entity types among the entity with the given name and its subtypes.

Specified by:

scope in interface BatchMappingContext

Specified by:

scope in interface SearchScopeProvider

Type Parameters:

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

Parameters:

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

entityName - An entity name. See Entity.name(). The referenced entity type must be an indexed entity type or a supertype of such type.

Returns:

The created scope.

See Also:

• SearchScope

scope

public <T> SearchScopeImpl<T> scope(Collection<? extends Class<? extends T>> classes)

Description copied from interface: SearchScopeProvider

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

Specified by:

scope in interface BatchMappingContext

Specified by:

scope in interface SearchScopeProvider

Type Parameters:

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

Parameters:

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

Returns:

The created scope.

See Also:

• SearchScope

scope

public <T> SearchScopeImpl<T> scope(Class<T> expectedSuperType,
 Collection<String> entityNames)

Description copied from interface: SearchScopeProvider

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

Specified by:

scope in interface SearchScopeProvider

Type Parameters:

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

Parameters:

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

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

Returns:

The created scope.

See Also:

• SearchScope

toEntityManagerFactory

public EntityManagerFactory toEntityManagerFactory()

Specified by:

toEntityManagerFactory in interface SearchMapping

Returns:

The underlying EntityManagerFactory used by this SearchMapping.

toOrmSessionFactory

public SessionFactory toOrmSessionFactory()

Specified by:

toOrmSessionFactory in interface SearchMapping

Returns:

The underlying SessionFactory used by this SearchMapping.

indexedEntity

public <E> SearchIndexedEntity<E> indexedEntity(Class<E> entityType)

Specified by:

indexedEntity in interface SearchMapping

Type Parameters:

E - The type of an indexed entity.

Parameters:

entityType - The type of an indexed entity. This must be the exact type; passing the type of a mapped-superclass for example will not work.

Returns:

A SearchIndexedEntity for the indexed entity with the exact given type.

indexedEntity

public SearchIndexedEntity<?> indexedEntity(String entityName)

Specified by:

indexedEntity in interface SearchMapping

Parameters:

entityName - The name of an indexed entity. See Entity.name().

Returns:

A SearchIndexedEntity for the indexed entity with the given name.

allIndexedEntities

public Collection<SearchIndexedEntity<?>> allIndexedEntities()

Specified by:

allIndexedEntities in interface SearchMapping

Returns:

A collection containing one SearchIndexedEntity for each indexed entity

indexManager

public IndexManager indexManager(String indexName)

Specified by:

indexManager in interface SearchMapping

Parameters:

indexName - The name of an index. See Indexed.index().

Returns:

The index manager for the index having indexName as name.

backend

public Backend backend()

Specified by:

backend in interface SearchMapping

Returns:

The default backend, if any.

backend

public Backend backend(String backendName)

Specified by:

backend in interface SearchMapping

Parameters:

backendName - The name of a backend. See Indexed.backend().

Returns:

The backend having backendName as name.

indexingPlanFilter

public void indexingPlanFilter(SearchIndexingPlanFilter filter)

Description copied from interface: SearchMapping

Set a filter defining which types must be included/excluded when indexed within indexing plans (either automatically or manually).

This does not affect indexing that does not rely on indexing plans, like the mass indexer.

By default, all indexed and contained types are included.

Specified by:

indexingPlanFilter in interface SearchMapping

Parameters:

filter - The filter that includes/excludes types when indexed.

applicationIndexingPlanFilter

public ConfiguredSearchIndexingPlanFilter applicationIndexingPlanFilter()

Specified by:

applicationIndexingPlanFilter in interface HibernateOrmSearchSessionMappingContext

configuredSearchIndexingPlanFilter

public ConfiguredSearchIndexingPlanFilter configuredSearchIndexingPlanFilter(SearchIndexingPlanFilter filter)

Specified by:

configuredSearchIndexingPlanFilter in interface HibernateOrmSearchSessionMappingContext

toConcreteType

public HibernateOrmMapping toConcreteType()

Specified by:

toConcreteType in interface MappingImplementor<HibernateOrmMapping>

cacheLookupStrategy

public EntityLoadingCacheLookupStrategy cacheLookupStrategy()

Specified by:

cacheLookupStrategy in interface HibernateOrmLoadingMappingContext

fetchSize

public int fetchSize()

Specified by:

fetchSize in interface HibernateOrmLoadingMappingContext

sessionFactory

public SessionFactoryImplementor sessionFactory()

Specified by:

sessionFactory in interface AutomaticIndexingMappingContext

Specified by:

sessionFactory in interface HibernateOrmLoadingMappingContext

Specified by:

sessionFactory in interface HibernateOrmMappingContext

Returns:

The Hibernate ORM SessionFactory.

tenancyConfiguration

public TenancyConfiguration tenancyConfiguration()

Specified by:

tenancyConfiguration in interface AutomaticIndexingMappingContext

Specified by:

tenancyConfiguration in interface BatchMappingContext

Specified by:

tenancyConfiguration in interface HibernateOrmMassIndexingMappingContext

massIndexingDefaultCleanOperation

public MassIndexingDefaultCleanOperation massIndexingDefaultCleanOperation()

Specified by:

massIndexingDefaultCleanOperation in interface BatchMappingContext

Specified by:

massIndexingDefaultCleanOperation in interface HibernateOrmMassIndexingMappingContext

sessionContext

public HibernateOrmScopeSessionContext sessionContext(EntityManager entityManager)

Specified by:

sessionContext in interface BatchMappingContext

Specified by:

sessionContext in interface HibernateOrmLoadingMappingContext

Specified by:

sessionContext in interface HibernateOrmScopeMappingContext

listenerEnabled

public boolean listenerEnabled()

Specified by:

listenerEnabled in interface HibernateOrmListenerContextProvider

listenerEnabled

public void listenerEnabled(boolean enabled)

backgroundIndexingCompletion

public CompletableFuture<?> backgroundIndexingCompletion()

createMassIndexerAgent

public PojoMassIndexerAgent createMassIndexerAgent(PojoMassIndexerAgentCreateContext context)

Description copied from interface: PojoMassIndexingMappingContext

Creates a PojoMassIndexerAgent, able to exert control over other agents that could perform indexing concurrently (e.g. indexing plans).

Specified by:

createMassIndexerAgent in interface PojoMassIndexingMappingContext

Parameters:

context - A context with information about the mass indexing that is about to start.

Returns:

An agent.

currentIndexingPlanIfExisting

public PojoIndexingPlan currentIndexingPlanIfExisting(SessionImplementor session)

Specified by:

currentIndexingPlanIfExisting in interface HibernateOrmListenerContextProvider

currentIndexingPlanIfTypeIncluded

public PojoTypeIndexingPlan currentIndexingPlanIfTypeIncluded(SessionImplementor session,
 PojoRawTypeIdentifier<?> typeIdentifier)

Specified by:

currentIndexingPlanIfTypeIncluded in interface HibernateOrmListenerContextProvider

createIndexingQueueEventProcessingPlan

public AutomaticIndexingQueueEventProcessingPlan createIndexingQueueEventProcessingPlan(Session session)

Specified by:

createIndexingQueueEventProcessingPlan in interface AutomaticIndexingMappingContext

Parameters:

session - A Hibernate ORM Session created from the same AutomaticIndexingMappingContext.sessionFactory() as this mapping.

Returns:

An event processing plan for the given session. It will not get executed automatically: you need to call AutomaticIndexingQueueEventProcessingPlan.executeAndReport(OperationSubmitter), which is asynchronous and returns a future.

currentAutomaticIndexingSynchronizationStrategy

public ConfiguredIndexingPlanSynchronizationStrategy currentAutomaticIndexingSynchronizationStrategy(SessionImplementor session)

Specified by:

currentAutomaticIndexingSynchronizationStrategy in interface HibernateOrmListenerContextProvider

typeContextProvider

public org.hibernate.search.mapper.orm.mapping.impl.HibernateOrmTypeContextContainer typeContextProvider()

Specified by:

typeContextProvider in interface BatchMappingContext

Specified by:

typeContextProvider in interface HibernateOrmListenerContextProvider

createScope

public <T> SearchScopeImpl<T> createScope(Collection<? extends Class<? extends T>> classes)

Specified by:

createScope in interface HibernateOrmSearchSessionMappingContext

createScope

public <T> SearchScopeImpl<T> createScope(Class<T> expectedSuperType,
 Collection<String> entityNames)

Specified by:

createScope in interface HibernateOrmSearchSessionMappingContext

createSessionBuilder

public HibernateOrmSearchSession.Builder createSessionBuilder(SessionImplementor sessionImplementor)

Specified by:

createSessionBuilder in interface HibernateOrmSearchSessionMappingContext

coordinationStrategy

public CoordinationStrategy coordinationStrategy()

Specified by:

coordinationStrategy in interface CoordinationStrategyContext