Package org.apache.tika.pipes.pipesiterator.fs

Class FileSystemPipesIterator

java.lang.Object

org.apache.tika.config.ConfigBase

org.apache.tika.pipes.pipesiterator.PipesIterator

org.apache.tika.pipes.pipesiterator.fs.FileSystemPipesIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<FetchEmitTuple>, Callable<Integer>, Initializable, TotalCounter

public class FileSystemPipesIterator
extends PipesIterator
implements TotalCounter, Initializable, Closeable

Field Summary

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

COMPLETED_SEMAPHORE, DEFAULT_MAX_WAIT_MS, DEFAULT_QUEUE_SIZE

Constructor Summary

Constructors

Constructor	Description
FileSystemPipesIterator()
FileSystemPipesIterator(Path basePath)

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
void	close()
protected void	enqueue()
TotalCountResult	getTotalCount()	Returns the total count so far.
void	initialize(Map<String,Param> params)
void	setBasePath(String basePath)
void	setCountTotal(boolean countTotal)
void	startTotalCount()

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

build, call, getEmitterName, getFetcherName, getHandlerConfig, getOnParseException, iterator, setEmitterName, setFetcherName, setHandlerType, setMaxEmbeddedResources, setMaxWaitMs, setOnParseException, setOnParseException, setParseMode, setParseMode, setQueueSize, setThrowOnWriteLimitReached, setWriteLimit, tryToAdd

Methods inherited from class org.apache.tika.config.ConfigBase

buildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings

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

Constructor Details

FileSystemPipesIterator

public FileSystemPipesIterator()

FileSystemPipesIterator

public FileSystemPipesIterator(Path basePath)

Method Details

setBasePath

@Field
public void setBasePath(String basePath)

enqueue

protected void enqueue()
                throws InterruptedException,
IOException,
TimeoutException

Specified by:

enqueue in class PipesIterator

Throws:

InterruptedException

IOException

TimeoutException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Overrides:

checkInitialization in class PipesIterator

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Specified by:

initialize in interface Initializable

Overrides:

initialize in class PipesIterator

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

setCountTotal

@Field
public void setCountTotal(boolean countTotal)

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