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

Class AbstractPojoMappingImplementor<M>

java.lang.Object

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

All Implemented Interfaces:

BackendMappingContext, MappingImplementor<M>, BridgeMappingContext, PojoMassIndexingMappingContext, PojoScopeMappingContext, PojoSearchSessionMappingContext, PojoWorkMappingContext

Direct Known Subclasses:

HibernateOrmMapping

public abstract class AbstractPojoMappingImplementor<M>
extends Object
implements MappingImplementor<M>, PojoScopeMappingContext, PojoSearchSessionMappingContext

Constructor Summary

Constructors

Constructor	Description
AbstractPojoMappingImplementor(PojoMappingDelegate delegate)
AbstractPojoMappingImplementor(PojoMappingDelegate delegate, PojoEntityReferenceFactoryDelegate entityReferenceFactoryDelegate)	Deprecated. Use AbstractPojoMappingImplementor.

Method Summary

Modifier and Type	Method	Description
PojoIndexer	createIndexer(PojoWorkSessionContext context)
PojoIndexingPlan	createIndexingPlan(PojoWorkSessionContext context, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
PojoIndexingPlan	createIndexingPlan(PojoWorkSessionContext context, PojoIndexingQueueEventSendingPlan sendingPlan)
PojoIndexingQueueEventProcessingPlan	createIndexingQueueEventProcessingPlan(PojoWorkSessionContext context, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy, PojoIndexingQueueEventSendingPlan sendingPlan)
protected PojoMappingDelegate	delegate()
protected void	doStop()
EntityReferenceFactory	entityReferenceFactory()
PojoEntityReferenceFactoryDelegate	entityReferenceFactoryDelegate()
FailureHandler	failureHandler()
BackendMappingHints	hints()
IdentifierBridgeToDocumentIdentifierContext	identifierBridgeToDocumentIdentifierContext()
CompletableFuture<?>	preStop(MappingPreStopContext context)	Prepare for MappingImplementor.stop(), executing any operations that needs to be executed before shutdown.
ProjectionRegistry	projectionRegistry()
CompletableFuture<?>	start(MappingStartContext context)	Start any resource necessary to operate the mapping at runtime.
void	stop()	Stop and release any resource necessary to operate the mapping at runtime.
ThreadPoolProvider	threadPoolProvider()
ToDocumentValueConvertContext	toDocumentValueConvertContext()
ValueBridgeToIndexedValueContext	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.engine.backend.mapping.spi.BackendMappingContext

mappedTypeContext

Methods inherited from interface org.hibernate.search.engine.mapper.mapping.spi.MappingImplementor

toConcreteType

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

createMassIndexerAgent

Constructor Detail

AbstractPojoMappingImplementor

public AbstractPojoMappingImplementor(PojoMappingDelegate delegate)

AbstractPojoMappingImplementor

@Deprecated
public AbstractPojoMappingImplementor(PojoMappingDelegate delegate,
                                      PojoEntityReferenceFactoryDelegate entityReferenceFactoryDelegate)

Deprecated.

Use AbstractPojoMappingImplementor. This constructor is only present for backwards compatibility, for mappers that expose a custom entity reference type.

Parameters:

delegate - The PojoMappingDelegate

entityReferenceFactoryDelegate - The PojoEntityReferenceFactoryDelegate, used to implement the EntityReferenceFactory.

Method Detail

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<M>

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<M>

Parameters:

context - The pre-stop context.

Returns:

A future that completes when pre-stop operations complete.

stop

public void stop()

Description copied from interface: MappingImplementor

Stop and release any resource necessary to operate the mapping at runtime.

Called by the engine once before shutdown.

Specified by:

stop in interface MappingImplementor<M>

hints

public BackendMappingHints hints()

Specified by:

hints in interface BackendMappingContext

threadPoolProvider

public ThreadPoolProvider threadPoolProvider()

Specified by:

threadPoolProvider in interface PojoMassIndexingMappingContext

Returns:

A ThreadPoolProvider.

failureHandler

public FailureHandler failureHandler()

Specified by:

failureHandler in interface PojoMassIndexingMappingContext

Returns:

A FailureHandler.

entityReferenceFactoryDelegate

public final PojoEntityReferenceFactoryDelegate entityReferenceFactoryDelegate()

Specified by:

entityReferenceFactoryDelegate in interface PojoMassIndexingMappingContext

Specified by:

entityReferenceFactoryDelegate in interface PojoScopeMappingContext

Specified by:

entityReferenceFactoryDelegate in interface PojoWorkMappingContext

Returns:

A PojoEntityReferenceFactoryDelegate.

entityReferenceFactory

public final EntityReferenceFactory entityReferenceFactory()

Specified by:

entityReferenceFactory in interface BackendMappingContext

Returns:

A EntityReferenceFactory.

toDocumentValueConvertContext

public final ToDocumentValueConvertContext toDocumentValueConvertContext()

Specified by:

toDocumentValueConvertContext in interface BackendMappingContext

projectionRegistry

public ProjectionRegistry projectionRegistry()

Specified by:

projectionRegistry in interface BackendMappingContext

identifierBridgeToDocumentIdentifierContext

public final IdentifierBridgeToDocumentIdentifierContext identifierBridgeToDocumentIdentifierContext()

Specified by:

identifierBridgeToDocumentIdentifierContext in interface BridgeMappingContext

valueBridgeToIndexedValueContext

public ValueBridgeToIndexedValueContext valueBridgeToIndexedValueContext()

Specified by:

valueBridgeToIndexedValueContext in interface BridgeMappingContext

createIndexingPlan

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

Specified by:

createIndexingPlan in interface PojoSearchSessionMappingContext

createIndexingPlan

public PojoIndexingPlan createIndexingPlan(PojoWorkSessionContext context,
                                           PojoIndexingQueueEventSendingPlan sendingPlan)

Specified by:

createIndexingPlan in interface PojoSearchSessionMappingContext

createIndexer

public PojoIndexer createIndexer(PojoWorkSessionContext context)

Specified by:

createIndexer in interface PojoSearchSessionMappingContext

createIndexingQueueEventProcessingPlan

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

Specified by:

createIndexingQueueEventProcessingPlan in interface PojoSearchSessionMappingContext

delegate

protected final PojoMappingDelegate delegate()

doStop

protected void doStop()