Package org.hibernate.search.mapper.orm.massindexing

Interface MassIndexingMonitor

All Superinterfaces:
MassIndexingMonitor
@Deprecated public interface MassIndexingMonitor extends MassIndexingMonitor
Deprecated.
move to MassIndexingMonitor.
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 Details

    • documentsAdded

      @Deprecated void documentsAdded(long increment)
      Deprecated.
      move to MassIndexingMonitor.documentsAdded(long).
      Notify the monitor that increment 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 then documentsAdded(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 interface MassIndexingMonitor
      Parameters:
      increment - additional number of documents built

    • documentsBuilt

      @Deprecated void documentsBuilt(long increment)
      Deprecated.
      move to MassIndexingMonitor.documentsBuilt(long).
      Notify the monitor that increment 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 then documentsBuilt(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 interface MassIndexingMonitor
      Parameters:
      increment - additional number of documents built

    • entitiesLoaded

      @Deprecated void entitiesLoaded(long increment)
      Deprecated.
      move to MassIndexingMonitor.entitiesLoaded(long).
      Notify the monitor that increment 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 then entitiesLoaded(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 interface MassIndexingMonitor
      Parameters:
      increment - additional number of entities loaded from database

    • addToTotalCount

      @Deprecated void addToTotalCount(long increment)
      Deprecated.
      move to MassIndexingMonitor.addToTotalCount(long).
      Notify the monitor that increment 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 then addToTotalCount(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 interface MassIndexingMonitor
      Parameters:
      increment - additional number of entities that will be indexed

    • indexingCompleted

      @Deprecated void indexingCompleted()
      Deprecated.
      move to MassIndexingMonitor.indexingCompleted().
      Notify the monitor that indexing is complete.
      Specified by:
      indexingCompleted in interface MassIndexingMonitor