Package org.hibernate.search.mapper.pojo.massindexing.impl

Class PojoDefaultMassIndexer

java.lang.Object

org.hibernate.search.mapper.pojo.massindexing.impl.PojoDefaultMassIndexer

All Implemented Interfaces:

PojoMassIndexer

public class PojoDefaultMassIndexer
extends Object
implements PojoMassIndexer

Prepares and configures a BatchIndexingWorkspace to start rebuilding the indexes for all entity instances in the database.The type of these entities is either all indexed entities or a subset, always including all subtypes.

Author:

Sanne Grinovero

Constructor Summary

Constructors

Constructor	Description
PojoDefaultMassIndexer(PojoMassIndexingContext massIndexingContext, PojoMassIndexingMappingContext mappingContext, PojoMassIndexingTypeContextProvider typeContextProvider, Set<? extends PojoMassIndexingIndexedTypeContext<?>> targetedIndexedTypes, PojoScopeSchemaManager scopeSchemaManager, PojoScopeDelegate<?,?,?> pojoScopeDelegate)

Method Summary

Modifier and Type	Method	Description
PojoDefaultMassIndexer	dropAndCreateSchemaOnStart(boolean enable)	Drops the indexes and their schema (if they exist) and re-creates them before indexing.
PojoMassIndexer	environment(MassIndexingEnvironment environment)	Sets the MassIndexingEnvironment, which can set up an environment (thread locals, ...) in mass indexing threads.
PojoMassIndexer	failureFloodingThreshold(long threshold)	Sets the threshold for failures that will be reported and sent to MassIndexingFailureHandler per indexed type.
PojoDefaultMassIndexer	failureHandler(MassIndexingFailureHandler failureHandler)	Sets the MassIndexingFailureHandler.
PojoDefaultMassIndexer	mergeSegmentsAfterPurge(boolean enable)	Merges each index into a single segment after the initial index purge, just before indexing.
PojoDefaultMassIndexer	mergeSegmentsOnFinish(boolean enable)	Merges each index into a single segment after indexing.
PojoDefaultMassIndexer	monitor(MassIndexingMonitor monitor)	Sets the MassIndexingMonitor.
PojoDefaultMassIndexer	purgeAllOnStart(boolean enable)	Removes all entities from the indexes before indexing.
CompletableFuture<?>	start()	Starts the indexing process in background (asynchronous).
void	startAndWait()	Starts the indexing process, and then block until it's finished.
PojoDefaultMassIndexer	threadsToLoadObjects(int numberOfThreads)	Sets the number of threads to be used to load the root entities.
PojoDefaultMassIndexer	typesToIndexInParallel(int numberOfThreads)	Sets the number of entity types to be indexed in parallel.

Methods inherited from class java.lang.Object

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

Constructor Details

PojoDefaultMassIndexer

public PojoDefaultMassIndexer(PojoMassIndexingContext massIndexingContext,
 PojoMassIndexingMappingContext mappingContext,
 PojoMassIndexingTypeContextProvider typeContextProvider,
 Set<? extends PojoMassIndexingIndexedTypeContext<?>> targetedIndexedTypes,
 PojoScopeSchemaManager scopeSchemaManager,
 PojoScopeDelegate<?,?,?> pojoScopeDelegate)

Method Details

typesToIndexInParallel

public PojoDefaultMassIndexer typesToIndexInParallel(int numberOfThreads)

Description copied from interface: PojoMassIndexer

Sets the number of entity types to be indexed in parallel.

Defaults to 1.

Specified by:

typesToIndexInParallel in interface PojoMassIndexer

Parameters:

numberOfThreads - number of entity types to be indexed in parallel

Returns:

this for method chaining

threadsToLoadObjects

public PojoDefaultMassIndexer threadsToLoadObjects(int numberOfThreads)

Description copied from interface: PojoMassIndexer

Sets the number of threads to be used to load the root entities.

Specified by:

threadsToLoadObjects in interface PojoMassIndexer

Parameters:

numberOfThreads - the number of threads

Returns:

this for method chaining

mergeSegmentsOnFinish

public PojoDefaultMassIndexer mergeSegmentsOnFinish(boolean enable)

Description copied from interface: PojoMassIndexer

Merges each index into a single segment after indexing.

Defaults to false.

Specified by:

mergeSegmentsOnFinish in interface PojoMassIndexer

Parameters:

enable - true to enable this operation, false to disable it.

Returns:

this for method chaining

mergeSegmentsAfterPurge

public PojoDefaultMassIndexer mergeSegmentsAfterPurge(boolean enable)

Description copied from interface: PojoMassIndexer

Merges each index into a single segment after the initial index purge, just before indexing.

Defaults to true.

This setting has no effect if purgeAllOnStart is set to false.

Specified by:

mergeSegmentsAfterPurge in interface PojoMassIndexer

Parameters:

enable - true to enable this operation, false to disable it.

Returns:

this for method chaining

dropAndCreateSchemaOnStart

public PojoDefaultMassIndexer dropAndCreateSchemaOnStart(boolean enable)

Description copied from interface: PojoMassIndexer

Drops the indexes and their schema (if they exist) and re-creates them before indexing.

Indexes will be unavailable for a short time during the dropping and re-creation, so this should only be used when failures of concurrent operations on the indexes (indexing caused by entity changes, ...) are acceptable.

This should be used when the existing schema is known to be obsolete, for example when the Hibernate Search mapping changed and some fields now have a different type, a different analyzer, new capabilities (projectable, ...), etc.

This may also be used when the schema is up-to-date, since it can be faster than a purge on large indexes.

Defaults to false.

Specified by:

dropAndCreateSchemaOnStart in interface PojoMassIndexer

Parameters:

enable - if true the indexes and their schema will be dropped then re-created before starting the indexing

Returns:

this for method chaining

purgeAllOnStart

public PojoDefaultMassIndexer purgeAllOnStart(boolean enable)

Description copied from interface: PojoMassIndexer

Removes all entities from the indexes before indexing.

Set this to false only if you know there are no entities in the indexes: otherwise search results may be duplicated.

Default value depends on PojoMassIndexer.dropAndCreateSchemaOnStart(boolean). Defaults to false if the mass indexer is configured to drop and create the schema on start, to true otherwise.

Specified by:

purgeAllOnStart in interface PojoMassIndexer

Parameters:

enable - if true all entities will be removed from the indexes before starting the indexing

Returns:

this for method chaining

monitor

public PojoDefaultMassIndexer monitor(MassIndexingMonitor monitor)

Description copied from interface: PojoMassIndexer

Sets the MassIndexingMonitor.

The default monitor just logs the progress.

Specified by:

monitor in interface PojoMassIndexer

Parameters:

monitor - The monitor that will track mass indexing progress.

Returns:

this for method chaining

start

public CompletableFuture<?> start()

Description copied from interface: PojoMassIndexer

Starts the indexing process in background (asynchronous).

May only be called once.

Specified by:

start in interface PojoMassIndexer

Returns:

a CompletionStage to react to the completion of the indexing task. Call CompletionStage.toCompletableFuture() on the returned object to convert it to a CompletableFuture (which implements Future).

startAndWait

public void startAndWait()
                  throws InterruptedException

Description copied from interface: PojoMassIndexer

Starts the indexing process, and then block until it's finished.

May only be called once.

Specified by:

startAndWait in interface PojoMassIndexer

Throws:

InterruptedException - if the current thread is interrupted while waiting.

failureHandler

public PojoDefaultMassIndexer failureHandler(MassIndexingFailureHandler failureHandler)

Description copied from interface: PojoMassIndexer

Sets the MassIndexingFailureHandler.

The default handler just forwards failures to the background failure handler.

Specified by:

failureHandler in interface PojoMassIndexer

Parameters:

failureHandler - The handler for failures occurring during mass indexing.

Returns:

this for method chaining

environment

public PojoMassIndexer environment(MassIndexingEnvironment environment)

Description copied from interface: PojoMassIndexer

Sets the MassIndexingEnvironment, which can set up an environment (thread locals, ...) in mass indexing threads.

Specified by:

environment in interface PojoMassIndexer

Parameters:

environment - a component that gets a chance to set up e.g. ThreadLocals in mass indexing threads before mass indexing starts, and to remove them after mass indexing stops.

See Also:

• MassIndexingEnvironment

failureFloodingThreshold

public PojoMassIndexer failureFloodingThreshold(long threshold)

Description copied from interface: PojoMassIndexer

Sets the threshold for failures that will be reported and sent to MassIndexingFailureHandler per indexed type. Any failures exceeding this number will be ignored. A count of such ignored failures together with the operation they belong to will be reported to the failure handler upon the completion of indexing process.

Specified by:

failureFloodingThreshold in interface PojoMassIndexer

Parameters:

threshold - The number of failures during one mass indexing beyond which the failure handler will no longer be notified. This threshold is reached separately for each indexed type. Overrides the threshold defined by the failure handler itself.

Defaults to 100 with the default failure handler.

Returns:

this for method chaining