Package org.hibernate.search.backend.lucene.work.execution.impl

Class LuceneIndexIndexer

java.lang.Object

org.hibernate.search.backend.lucene.work.execution.impl.LuceneIndexIndexer

All Implemented Interfaces:

IndexIndexer

public class LuceneIndexIndexer
extends Object
implements IndexIndexer

Constructor Summary

Constructors

Constructor	Description
LuceneIndexIndexer(LuceneWorkFactory factory, LuceneIndexEntryFactory indexEntryFactory, WorkExecutionIndexManagerContext indexManagerContext, BackendSessionContext sessionContext)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<?>	add(DocumentReferenceProvider referenceProvider, DocumentContributor documentContributor, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy, OperationSubmitter operationSubmitter)	Add a document to the index, assuming that the document is absent from the index.
CompletableFuture<?>	addOrUpdate(DocumentReferenceProvider referenceProvider, DocumentContributor documentContributor, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy, OperationSubmitter operationSubmitter)	Update a document in the index, or add it if it's absent from the index.
CompletableFuture<?>	delete(DocumentReferenceProvider referenceProvider, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy, OperationSubmitter operationSubmitter)	Delete a document from the index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LuceneIndexIndexer

public LuceneIndexIndexer(LuceneWorkFactory factory,
                          LuceneIndexEntryFactory indexEntryFactory,
                          WorkExecutionIndexManagerContext indexManagerContext,
                          BackendSessionContext sessionContext)

Method Detail

add

public CompletableFuture<?> add(DocumentReferenceProvider referenceProvider,
                                DocumentContributor documentContributor,
                                DocumentCommitStrategy commitStrategy,
                                DocumentRefreshStrategy refreshStrategy,
                                OperationSubmitter operationSubmitter)

Description copied from interface: IndexIndexer

Add a document to the index, assuming that the document is absent from the index.

Specified by:

add in interface IndexIndexer

Parameters:

referenceProvider - A source of information about the identity of the document to add.

documentContributor - A contributor to the document, adding fields to the indexed document.

commitStrategy - How to handle the commit.

refreshStrategy - How to handle the refresh.

operationSubmitter - How to handle request to submit operation when the queue is full

Returns:

A CompletableFuture that completes once the document is added.

addOrUpdate

public CompletableFuture<?> addOrUpdate(DocumentReferenceProvider referenceProvider,
                                        DocumentContributor documentContributor,
                                        DocumentCommitStrategy commitStrategy,
                                        DocumentRefreshStrategy refreshStrategy,
                                        OperationSubmitter operationSubmitter)

Description copied from interface: IndexIndexer

Update a document in the index, or add it if it's absent from the index.

Specified by:

addOrUpdate in interface IndexIndexer

Parameters:

referenceProvider - A source of information about the identity of the document to update.

documentContributor - A contributor to the document, adding fields to the indexed document.

commitStrategy - How to handle the commit.

refreshStrategy - How to handle the refresh.

operationSubmitter - How to handle request to submit operation when the queue is full

Returns:

A CompletableFuture that completes once the document is updated.

delete

public CompletableFuture<?> delete(DocumentReferenceProvider referenceProvider,
                                   DocumentCommitStrategy commitStrategy,
                                   DocumentRefreshStrategy refreshStrategy,
                                   OperationSubmitter operationSubmitter)

Description copied from interface: IndexIndexer

Delete a document from the index.

Specified by:

delete in interface IndexIndexer

Parameters:

referenceProvider - A source of information about the identity of the document to delete.

commitStrategy - How to handle the commit.

refreshStrategy - How to handle the refresh.

operationSubmitter - How to handle request to submit operation when the queue is full

Returns:

A CompletableFuture that completes once the document is deleted.