org.apache.tika.pipes.pipesiterator

Interface TotalCounter

All Known Implementing Classes:

FileSystemPipesIterator

public interface TotalCounter

Interface for pipesiterators that allow counting of total documents. This is useful for user-facing frontends where the user does not have easy access to the total number of files for processing. This is run in a daemon thread and is not guaranteed to complete before the actual file processing has completed. This is an ancillary task, and should not throw runtime exceptions. Implementers should be careful to check for thread interrupts.

Method Summary

Modifier and Type	Method and Description
TotalCountResult	getTotalCount() Returns the total count so far.
void	startTotalCount()

Method Detail

startTotalCount

void startTotalCount()

getTotalCount

TotalCountResult getTotalCount()

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.

Returns: