Package org.hibernate.search.batchindexing

Interface MassIndexerProgressMonitor

All Known Implementing Classes:
IndexingProgressMonitor, SimpleIndexingProgressMonitor
public interface MassIndexerProgressMonitor
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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addToTotalCount(long count)
    The total count of entities to be indexed is added here; It could be called more than once, the implementation should add them up.
    void
    documentsAdded(long increment)
    The number of documents sent to the backend; This is invoked several times during the indexing process.
    void
    documentsBuilt(int number)
    The number of Documents built; This is invoked several times and concurrently during the indexing process.
    void
    entitiesLoaded(int size)
    The number of entities loaded from database; This is invoked several times and concurrently during the indexing process.
    void
    indexingCompleted()
    Invoked when the indexing is completed.

  • Method Details

    • documentsAdded

      void documentsAdded(long increment)
      The number of documents sent to the backend; This is invoked several times during the indexing process.
      Parameters:
      increment - number of documents sent to backend

    • documentsBuilt

      void documentsBuilt(int number)
      The number of Documents built; This is invoked several times and concurrently during the indexing process.
      Parameters:
      number - number of Documents built

    • entitiesLoaded

      void entitiesLoaded(int size)
      The number of entities loaded from database; This is invoked several times and concurrently during the indexing process.
      Parameters:
      size - number of entities loaded from database

    • addToTotalCount

      void addToTotalCount(long count)
      The total count of entities to be indexed is added here; It could be called more than once, the implementation should add them up. This is invoked several times and concurrently during the indexing process.
      Parameters:
      count - number of newly indexed entities which has to be added to total count

    • indexingCompleted

      void indexingCompleted()
      Invoked when the indexing is completed.