Package org.alfresco.repo.batch

Interface BatchProcessWorkProvider<T>

@AlfrescoPublicApi public interface BatchProcessWorkProvider<T>
An interface that provides work loads to the BatchProcessor.
Since:
3.4
Author:
Derek Hulley

  • Method Details

    • getTotalEstimatedWorkSize

      @Deprecated int getTotalEstimatedWorkSize()
      Deprecated.
      use getTotalEstimatedWorkSizeLong() instead.
      Get an estimate of the total number of objects that will be provided by this instance. Instances can provide accurate answers on each call, but only if the answer can be provided quickly and efficiently; usually it is enough to to cache the result after providing an initial estimate.
      Returns:
      a total work size estimate

    • getNextWork

      Collection<T> getNextWork()
      Get the next lot of work for the batch processor. Implementations should return the largest number of entries possible; the BatchProcessor will keep calling this method until it has enough work for the individual worker threads to process or until the work load is empty.
      Returns:
      the next set of work object to process or an empty collection if there is no more work remaining.

    • getTotalEstimatedWorkSizeLong

      default long getTotalEstimatedWorkSizeLong()
      Get an estimate of the total number of objects that will be provided by this instance. Instances can provide accurate answers on each call, but only if the answer can be provided quickly and efficiently; usually it is enough to to cache the result after providing an initial estimate.
      Returns:
      a total work size estimate