com.marklogic.client.datamovement

Class DeleteListener

java.lang.Object

com.marklogic.client.datamovement.DeleteListener

All Implemented Interfaces:

BatchListener<QueryBatch>, QueryBatchListener

public class DeleteListener
extends java.lang.Object
implements QueryBatchListener

Sends a Java API bulk delete request for all the documents from each batch. Because it deletes documents, it should only be used when:

1. merge timestamp is enabled and QueryBatcher.withConsistentSnapshot() is called, or
2. newQueryBatcher(Iterator<String>) is used to traverse a static data set

When merge timestamp is enabled, pass a DeleteListener instance to QueryBatcher onUrisReady like so:

     QueryBatcher deleteBatcher = moveMgr.newQueryBatcher(query)
       .onUrisReady(new DeleteListener())
       .withConsistentSnapshot();
     JobTicket ticket = moveMgr.startJob(deleteBatcher);
     deleteBatcher.awaitCompletion();
     moveMgr.stopJob(ticket);

With Iterator<String>, pass a DeleteListener instance to QueryBatcher onUrisReady like so:

     QueryBatcher deleteBatcher = moveMgr.newQueryBatcher(query)
       .onUrisReady(new DeleteListener());
     JobTicket ticket = moveMgr.startJob(deleteBatcher);
     deleteBatcher.awaitCompletion();
     moveMgr.stopJob(ticket);

As with all the provided listeners, this listener will not meet the needs of all applications but the source code for it should serve as helpful sample code so you can write your own custom listeners.

Constructor Summary

Constructors

Constructor and Description
DeleteListener()

Method Summary

Modifier and Type	Method and Description
void	initializeListener(QueryBatcher queryBatcher) This implementation of initializeListener adds this instance of DeleteListener to the two RetryListener's in this QueryBatcher so they will retry any batches that fail during the delete request.
DeleteListener	onFailure(BatchFailureListener<QueryBatch> listener) When a batch fails or a callback throws an Exception, run this listener code.
void	processEvent(QueryBatch batch) The standard BatchListener action called by QueryBatcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteListener

public DeleteListener()

Method Detail

initializeListener

public void initializeListener(QueryBatcher queryBatcher)

This implementation of initializeListener adds this instance of DeleteListener to the two RetryListener's in this QueryBatcher so they will retry any batches that fail during the delete request.

Specified by:

initializeListener in interface QueryBatchListener

Parameters:

queryBatcher - the QueryBatcher which will call this Listener

processEvent

public void processEvent(QueryBatch batch)

The standard BatchListener action called by QueryBatcher.

Specified by:

processEvent in interface BatchListener<QueryBatch>

Specified by:

processEvent in interface QueryBatchListener

Parameters:

batch - the batch of uris and some metadata about the current status of the job

onFailure

public DeleteListener onFailure(BatchFailureListener<QueryBatch> listener)

When a batch fails or a callback throws an Exception, run this listener code. Multiple listeners can be registered with this method.

Parameters:

listener - the code to run when a failure occurs

Returns:

this instance for method chaining