org.icij.extract.queue

Class DocumentQueueDrainer

java.lang.Object

org.icij.concurrent.ExecutorProxy

org.icij.extract.queue.DocumentQueueDrainer

All Implemented Interfaces:

Shutdownable

public class DocumentQueueDrainer
extends ExecutorProxy

Drains a queue by polling for documents to consume.

Since:

1.0.0

Field Summary

Fields inherited from class org.icij.concurrent.ExecutorProxy

executor

Constructor Summary

Constructors

Constructor and Description
DocumentQueueDrainer(DocumentQueue queue, java.util.function.Consumer<TikaDocument> consumer) Create a new drainer that will drain documents from the given queue to the given consumer on a single thread.

Method Summary

Modifier and Type	Method and Description
void	clearLatch() Clear the latch.
void	clearPollTimeout() Causes the consumer to wait until a new file is available, without any timeout.
DocumentQueueDrainer	configure(Options<String> options)
Future<Long>	drain() Drain the queue in a non-blocking way until the draining thread is interrupted, the task is cancelled or the given timeout is reached (if any is set).
Future<Long>	drain(TikaDocument poison) Like drain() except that draining will stop when the given poison pill is returned from the queue.
SealableLatch	getLatch() Get the poll latch.
java.time.Duration	getPollTimeout() Get the poll timeout.
void	setLatch(SealableLatch latch) If given, the latch should be used to signal that the queue should be polled.
void	setPollTimeout(java.time.Duration pollTimeout) Set the amount of time to wait until an item becomes available.

Methods inherited from class org.icij.concurrent.ExecutorProxy

awaitTermination, shutdown, shutdownNow

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentQueueDrainer

public DocumentQueueDrainer(DocumentQueue queue,
                            java.util.function.Consumer<TikaDocument> consumer)

Create a new drainer that will drain documents from the given queue to the given consumer on a single thread.

Parameters:

queue - the queue to drain

consumer - must accept documents drained from the queue

Method Detail

configure

public DocumentQueueDrainer configure(Options<String> options)

setPollTimeout

public void setPollTimeout(java.time.Duration pollTimeout)

Set the amount of time to wait until an item becomes available.

Parameters:

pollTimeout - the amount of time to wait

clearPollTimeout

public void clearPollTimeout()

Causes the consumer to wait until a new file is available, without any timeout. To not wait at all, call setPollTimeout(Duration pollTimeout) with a value of 0.

getPollTimeout

public java.time.Duration getPollTimeout()

Get the poll timeout.

Returns:

The poll timeout.

setLatch

public void setLatch(SealableLatch latch)

If given, the latch should be used to signal that the queue should be polled. SealableLatch.await() will be called until polling returns a non-null value or the latch is sealed.

Parameters:

latch - the latch to await before polling

getLatch

public SealableLatch getLatch()

Get the poll latch.

Returns:

The poll latch.

clearLatch

public void clearLatch()

Clear the latch.

drain

public Future<Long> drain()

Drain the queue in a non-blocking way until the draining thread is interrupted, the task is cancelled or the given timeout is reached (if any is set).

Returns:

A Future representing the draining task that returns the number of documents consumed as a result.

drain

public Future<Long> drain(TikaDocument poison)

Like drain() except that draining will stop when the given poison pill is returned from the queue.

Parameters:

poison - the poison pill to test for when polling

See Also:

drain()