org.apache.tika.batch.fs

Class FSDirectoryCrawler

java.lang.Object

org.apache.tika.batch.FileResourceCrawler

org.apache.tika.batch.fs.FSDirectoryCrawler

All Implemented Interfaces:

java.util.concurrent.Callable<IFileProcessorFutureResult>

public class FSDirectoryCrawler
extends FileResourceCrawler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSDirectoryCrawler.CRAWL_ORDER
private class	FSDirectoryCrawler.FileNameComparator

Field Summary

Fields

Modifier and Type	Field and Description
private FSDirectoryCrawler.CRAWL_ORDER	crawlOrder
private java.util.Comparator<java.nio.file.Path>	pathComparator
private java.nio.file.Path	root
private java.nio.file.Path	startDirectory

Fields inherited from class org.apache.tika.batch.FileResourceCrawler

ADDED, LOG, SKIPPED, STOP_NOW

Constructor Summary

Constructors

Constructor and Description
FSDirectoryCrawler(java.util.concurrent.ArrayBlockingQueue<FileResource> fileQueue, int numConsumers, java.nio.file.Path root, FSDirectoryCrawler.CRAWL_ORDER crawlOrder)
FSDirectoryCrawler(java.util.concurrent.ArrayBlockingQueue<FileResource> fileQueue, int numConsumers, java.nio.file.Path root, java.nio.file.Path startDirectory, FSDirectoryCrawler.CRAWL_ORDER crawlOrder)

Method Summary

Modifier and Type	Method and Description
private void	addFiles(java.nio.file.Path directory)
void	handleFirstFileInDirectory(java.nio.file.Path f) Override this if you have any special handling for the first actual file that the crawler comes across in a directory.
void	start() Implement this to control the addition of FileResources.

Methods inherited from class org.apache.tika.batch.FileResourceCrawler

call, getAdded, getConsidered, isActive, isQueueEmpty, select, setDocumentSelector, setMaxConsecWaitInMillis, setMaxFilesToAdd, setMaxFilesToConsider, shutDownNoPoison, tryToAdd, wasTimedOut

Methods inherited from class java.lang.Object

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

Field Detail

root

private final java.nio.file.Path root

startDirectory

private final java.nio.file.Path startDirectory

pathComparator

private final java.util.Comparator<java.nio.file.Path> pathComparator

crawlOrder

private FSDirectoryCrawler.CRAWL_ORDER crawlOrder

Constructor Detail

FSDirectoryCrawler

public FSDirectoryCrawler(java.util.concurrent.ArrayBlockingQueue<FileResource> fileQueue,
                          int numConsumers,
                          java.nio.file.Path root,
                          FSDirectoryCrawler.CRAWL_ORDER crawlOrder)

FSDirectoryCrawler

public FSDirectoryCrawler(java.util.concurrent.ArrayBlockingQueue<FileResource> fileQueue,
                          int numConsumers,
                          java.nio.file.Path root,
                          java.nio.file.Path startDirectory,
                          FSDirectoryCrawler.CRAWL_ORDER crawlOrder)

Method Detail

start

public void start()
           throws java.lang.InterruptedException

Description copied from class: FileResourceCrawler

Implement this to control the addition of FileResources. Call FileResourceCrawler.tryToAdd(org.apache.tika.batch.FileResource) to add FileResources to the queue.

Specified by:

start in class FileResourceCrawler

Throws:

java.lang.InterruptedException

addFiles

private void addFiles(java.nio.file.Path directory)
               throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

handleFirstFileInDirectory

public void handleFirstFileInDirectory(java.nio.file.Path f)

Override this if you have any special handling for the first actual file that the crawler comes across in a directory. For example, it might be handy to call mkdirs() on an output directory if your FileResourceConsumers are writing to a file.

Parameters:

f - file to handle