org.hibernate.search.engine.backend.index.spi

Interface IndexManagerImplementor<D extends DocumentElement>

All Superinterfaces:

AutoCloseable

public interface IndexManagerImplementor<D extends DocumentElement>
extends AutoCloseable

The object responsible for applying works and searches to a full-text index.

This is the interface implemented by backends and provided to the engine.

Method Summary

Modifier and Type	Method and Description
void	addTo(IndexScopeBuilder builder)
void	close()
IndexDocumentWorkExecutor<D>	createDocumentWorkExecutor(SessionContextImplementor sessionContext, DocumentCommitStrategy commitStrategy)
IndexScopeBuilder	createScopeBuilder(MappingContextImplementor mappingContext)
IndexWorkExecutor	createWorkExecutor(DetachedSessionContextImplementor sessionContext)
IndexWorkPlan<D>	createWorkPlan(SessionContextImplementor sessionContext, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
void	start(IndexManagerStartContext context) Start any resource necessary to operate the index manager at runtime.
IndexManager	toAPI()

Method Detail

start

void start(IndexManagerStartContext context)

Start any resource necessary to operate the index manager at runtime.

Called by the engine once after bootstrap, after BackendImplementor.start(BackendStartContext) was called on the corresponding backend.

Parameters:

context - The start context.

toAPI

IndexManager toAPI()

Returns:

The object that should be exposed as API to users.

createWorkPlan

IndexWorkPlan<D> createWorkPlan(SessionContextImplementor sessionContext,
                                DocumentCommitStrategy commitStrategy,
                                DocumentRefreshStrategy refreshStrategy)

createDocumentWorkExecutor

IndexDocumentWorkExecutor<D> createDocumentWorkExecutor(SessionContextImplementor sessionContext,
                                                        DocumentCommitStrategy commitStrategy)

createWorkExecutor

IndexWorkExecutor createWorkExecutor(DetachedSessionContextImplementor sessionContext)

createScopeBuilder

IndexScopeBuilder createScopeBuilder(MappingContextImplementor mappingContext)

addTo

void addTo(IndexScopeBuilder builder)

close

void close()

Specified by:

close in interface AutoCloseable