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

Interface MassIndexingTypeGroupMonitor

@Incubating public interface MassIndexingTypeGroupMonitor
A component that monitors progress of mass indexing within a type group.

Implementations must be threadsafe.

  • Method Details

    • documentsIndexed

      void documentsIndexed(long increment)
      Notify the monitor that increment more documents have been added to the index in this type group.

      Summing the numbers passed to this method gives the total number of documents that have been added to the index so far for this type group.

      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 for this type group".

      This method can be invoked from several threads thus implementors are required to be thread-safe.

      Parameters:
      increment - The additional number of documents built and added to the index.

    • indexingStarted

      void indexingStarted(MassIndexingTypeGroupMonitorContext context)
      Notify the monitor that indexing of the type group is starting and provide the expected number of entities in the group, if known.
      Parameters:
      context - A context object exposing additional information and operations that may be relevant for the implementors of this monitor.

    • indexingCompleted

      void indexingCompleted(MassIndexingTypeGroupMonitorContext context)
      Notify the monitor that indexing of the type group is completed.
      Parameters:
      context - A context object exposing additional information and operations that may be relevant for the implementors of this monitor.