Package org.apache.tika.pipes.iterator.fs

Class FileSystemPipesIterator

java.lang.Object

org.apache.tika.plugins.AbstractTikaExtension

org.apache.tika.pipes.pipesiterator.PipesIteratorBase

org.apache.tika.pipes.iterator.fs.FileSystemPipesIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<FetchEmitTuple>, Callable<Integer>, PipesIterator, TotalCounter, TikaExtension

public class FileSystemPipesIterator
extends PipesIteratorBase
implements TotalCounter, Closeable

Field Summary

Fields inherited from class org.apache.tika.pipes.pipesiterator.PipesIteratorBase

DEFAULT_MAX_WAIT_MS, 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

Method Summary

Modifier and Type	Method	Description
static FileSystemPipesIterator	build(ExtensionConfig pluginConfig)
void	checkConfig(FileSystemPipesIteratorConfig config)
void	close()
protected void	enqueue()
TotalCountResult	getTotalCount()	Returns the total count so far.
void	startTotalCount()

Methods inherited from class org.apache.tika.pipes.pipesiterator.PipesIteratorBase

call, iterator, tryToAdd

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

Method Details

build

public static FileSystemPipesIterator build(ExtensionConfig pluginConfig)
                                     throws TikaConfigException,
IOException

Throws:

TikaConfigException

IOException

enqueue

protected void enqueue()
                throws InterruptedException,
IOException,
TimeoutException

Specified by:

enqueue in class PipesIteratorBase

Throws:

InterruptedException

IOException

TimeoutException

checkConfig

public void checkConfig(FileSystemPipesIteratorConfig config)
                 throws TikaConfigException

Throws:

TikaConfigException

startTotalCount

public void startTotalCount()

Specified by:

startTotalCount in interface TotalCounter

getTotalCount

public TotalCountResult getTotalCount()

Description copied from interface: TotalCounter

Returns the total count so far. Check the TotalCountResult.getStatus() to figure out if the count has completed yet, if it is unsupported or if there was an exception during the counting.

Specified by:

getTotalCount in interface TotalCounter

Returns:

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException