LuceneBatchedWorkProcessor (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

java.lang.Object
- org.hibernate.search.backend.lucene.orchestration.impl.LuceneBatchedWorkProcessor

All Implemented Interfaces:

BatchedWorkProcessor
```
public class LuceneBatchedWorkProcessor
extends Object
implements BatchedWorkProcessor
```
A thread-safe component responsible for applying write works to an index writer.
Ported from Search 5's LuceneBackendQueueTask, in particular.

Constructor Summary

Constructors
Constructor Description

LuceneBatchedWorkProcessor(EventContext eventContext, IndexAccessor indexAccessor)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`beginBatch()`	Initializes internal state before works are submitted.
`void`	`complete()`	Executes any outstanding operation, or schedule their execution.
`CompletableFuture<?>`	`endBatch()`	Ensures all works submitted since the last call to `BatchedWorkProcessor.beginBatch()` will actually be executed, along with any finishing task (commit, ...).
`void`	`forceCommit()`
`void`	`forceRefresh()`
`<T> T`	`submit(IndexingWork<T> work)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LuceneBatchedWorkProcessor
```
public LuceneBatchedWorkProcessor(EventContext eventContext,
                                  IndexAccessor indexAccessor)
```
- Method Detail
  - beginBatch
```
public void beginBatch()
```
    Description copied from interface: BatchedWorkProcessor
    
    Initializes internal state before works are submitted.
    
    Specified by:
    
    beginBatch in interface BatchedWorkProcessor
  - endBatch
```
public CompletableFuture<?> endBatch()
```
    Description copied from interface: BatchedWorkProcessor
    
    Ensures all works submitted since the last call to BatchedWorkProcessor.beginBatch() will actually be executed, along with any finishing task (commit, ...).
    
    Specified by:
    
    endBatch in interface BatchedWorkProcessor
    
    Returns:
    
    A future completing when the executor is allowed to start another batch.
  - complete
```
public void complete()
```
    Description copied from interface: BatchedWorkProcessor
    
    Executes any outstanding operation, or schedule their execution.
    Called when the executor considers the work queue complete and does not plan on submitting another batch due to work starvation.
    
    Specified by:
    
    complete in interface BatchedWorkProcessor
  - submit
```
public <T> T submit(IndexingWork<T> work)
```
  - forceCommit
```
public void forceCommit()
```
  - forceRefresh
```
public void forceRefresh()
```