Interface MassIndexingMonitor
-
- All Superinterfaces:
MassIndexingMonitor
@Deprecated public interface MassIndexingMonitor extends MassIndexingMonitor
Deprecated.move toMassIndexingMonitor
.A component that monitors progress of mass indexing.As a MassIndexer can take some time to finish its job, it is often necessary to monitor its progress. The default, built-in monitor logs progress periodically at the INFO level, but a custom monitor can be set by implementing this interface and passing an instance to
MassIndexer.monitor(org.hibernate.search.mapper.pojo.massindexing.MassIndexingMonitor)
.Implementations must be threadsafe.
- Author:
- Sanne Grinovero, Hardy Ferentschik
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addToTotalCount(long increment)
Deprecated.void
documentsAdded(long increment)
Deprecated.void
documentsBuilt(long increment)
Deprecated.void
entitiesLoaded(long increment)
Deprecated.void
indexingCompleted()
Deprecated.
-
-
-
Method Detail
-
documentsAdded
@Deprecated void documentsAdded(long increment)
Deprecated.Notify the monitor thatincrement
more documents have been added to the index.Summing the numbers passed to this method gives the total number of documents that have been added to the index so far.
This method is invoked several times during indexing, and calls are incremental: calling
documentsAdded(3)
and thendocumentsAdded(1)
should be understood as "3+1 documents, i.e. 4 documents have been added to the index".This method can be invoked from several threads thus implementors are required to be thread-safe.
- Specified by:
documentsAdded
in interfaceMassIndexingMonitor
- Parameters:
increment
- additional number of documents built
-
documentsBuilt
@Deprecated void documentsBuilt(long increment)
Deprecated.Notify the monitor thatincrement
more documents have been built.Summing the numbers passed to this method gives the total number of documents that have been built so far.
This method is invoked several times during indexing, and calls are incremental: calling
documentsBuilt(3)
and thendocumentsBuilt(1)
should be understood as "3+1 documents, i.e. 4 documents have been built".This method can be invoked from several threads thus implementors are required to be thread-safe.
- Specified by:
documentsBuilt
in interfaceMassIndexingMonitor
- Parameters:
increment
- additional number of documents built
-
entitiesLoaded
@Deprecated void entitiesLoaded(long increment)
Deprecated.Notify the monitor thatincrement
more entities have been loaded from the database.Summing the numbers passed to this method gives the total number of entities that have been loaded so far.
This method is invoked several times during indexing, and calls are incremental: calling
entitiesLoaded(3)
and thenentitiesLoaded(1)
should be understood as "3+1 documents, i.e. 4 documents have been loaded".This method can be invoked from several threads thus implementors are required to be thread-safe.
- Specified by:
entitiesLoaded
in interfaceMassIndexingMonitor
- Parameters:
increment
- additional number of entities loaded from database
-
addToTotalCount
@Deprecated void addToTotalCount(long increment)
Deprecated.Notify the monitor thatincrement
more entities have been detected in the database and will be indexed.Summing the numbers passed to this method gives the total number of entities that Hibernate Search plans to index. This number can be incremented during indexing as Hibernate Search moves from one entity type to the next.
This method is invoked several times during indexing, and calls are incremental: calling
addToTotalCount(3)
and thenaddToTotalCount(1)
should be understood as "3+1 documents, i.e. 4 documents will be indexed".This method can be invoked from several threads thus implementors are required to be thread-safe.
- Specified by:
addToTotalCount
in interfaceMassIndexingMonitor
- Parameters:
increment
- additional number of entities that will be indexed
-
indexingCompleted
@Deprecated void indexingCompleted()
Deprecated.Notify the monitor that indexing is complete.- Specified by:
indexingCompleted
in interfaceMassIndexingMonitor
-
-