Package org.apache.tika.pipes.pipesiterator

Class PipesIteratorBase

java.lang.Object

org.apache.tika.plugins.AbstractTikaExtension

org.apache.tika.pipes.pipesiterator.PipesIteratorBase

All Implemented Interfaces:

Iterable<FetchEmitTuple>, Callable<Integer>, PipesIterator, TikaExtension

Direct Known Subclasses:

AZBlobPipesIterator, CSVPipesIterator, FileSystemPipesIterator, GCSPipesIterator, JDBCPipesIterator, JsonPipesIterator, KafkaPipesIterator, S3PipesIterator, SolrPipesIterator

public abstract class PipesIteratorBase
extends AbstractTikaExtension
implements PipesIterator

Abstract class that handles the testing for timeouts/thread safety issues. Concrete classes implement the blocking enqueue(). If there's an exception in the enqueuing thread, this will throw a RuntimeException. It will throw an IllegalStateException if next() is called after hasNext() has returned false.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_MAX_WAIT_MS
static final int	DEFAULT_QUEUE_SIZE

Fields inherited from class org.apache.tika.plugins.AbstractTikaExtension

pluginConfig

Fields inherited from interface org.apache.tika.pipes.api.pipesiterator.PipesIterator

COMPLETED_SEMAPHORE

Constructor Summary

Constructors

Constructor	Description
PipesIteratorBase(ExtensionConfig pluginConfig)

Method Summary

Modifier and Type	Method	Description
Integer	call()
protected abstract void	enqueue()
Iterator<FetchEmitTuple>	iterator()
protected void	tryToAdd(FetchEmitTuple p)

Methods inherited from class org.apache.tika.plugins.AbstractTikaExtension

getExtensionConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.tika.plugins.TikaExtension

getExtensionConfig

Field Details

DEFAULT_MAX_WAIT_MS

public static final long DEFAULT_MAX_WAIT_MS

See Also:

• Constant Field Values

DEFAULT_QUEUE_SIZE

public static final int DEFAULT_QUEUE_SIZE

See Also:

• Constant Field Values

Constructor Details

PipesIteratorBase

public PipesIteratorBase(ExtensionConfig pluginConfig)

Method Details

call

public Integer call()
             throws Exception

Specified by:

call in interface Callable<Integer>

Throws:

Exception

enqueue

protected abstract void enqueue()
                         throws IOException,
TimeoutException,
InterruptedException

Throws:

IOException

TimeoutException

InterruptedException

tryToAdd

protected void tryToAdd(FetchEmitTuple p)
                 throws InterruptedException,
TimeoutException

Throws:

InterruptedException

TimeoutException

iterator

public Iterator<FetchEmitTuple> iterator()

Specified by:

iterator in interface Iterable<FetchEmitTuple>