Package org.hibernate.search.batchindexing

Interface MassIndexerProgressMonitor

  • All Superinterfaces:
    IndexingMonitor
    @Deprecated
public interface MassIndexerProgressMonitor
extends IndexingMonitor
    Deprecated.
    Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a mass indexer with org.hibernate.search.mapper.orm.session.SearchSession#massIndexer(Class[]), and implement the interface org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor in your monitor. Refer to the migration guide for more information.
    As a MassIndexer can take some time to finish it's job, a MassIndexerProgressMonitor can be defined in the configuration property hibernate.search.worker.indexing.monitor implementing this interface to track indexing performance.

    Implementations must:

    • be threadsafe
    • have a no-arg constructor
    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.
      Notify the monitor that increment more entities have been detected in the database and will be indexed.
      void documentsBuilt​(int increment)
      Deprecated.
      Notify the monitor that increment more documents have been built.
      void entitiesLoaded​(int increment)
      Deprecated.
      Notify the monitor that increment more entities have been loaded from the database.
      void indexingCompleted()
      Deprecated.
      Notify the monitor that indexing is complete.

    • Method Detail

      • documentsBuilt

        void documentsBuilt​(int increment)
        Deprecated.
        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.

        Parameters:
        increment - additional number of documents built

      • entitiesLoaded

        void entitiesLoaded​(int increment)
        Deprecated.
        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.

        Parameters:
        increment - additional number of entities loaded from database

      • addToTotalCount

        void addToTotalCount​(long increment)
        Deprecated.
        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.

        Parameters:
        increment - additional number of entities that will be indexed

      • indexingCompleted

        void indexingCompleted()
        Deprecated.
        Notify the monitor that indexing is complete.