org.apache.tika.batch.fs

Class BasicTikaFSConsumer

java.lang.Object

org.apache.tika.batch.FileResourceConsumer

org.apache.tika.batch.fs.AbstractFSConsumer

org.apache.tika.batch.fs.BasicTikaFSConsumer

All Implemented Interfaces:

java.util.concurrent.Callable<IFileProcessorFutureResult>

public class BasicTikaFSConsumer
extends AbstractFSConsumer

Basic FileResourceConsumer that reads files from an input directory and writes content to the output directory.

This catches all exceptions and errors and then logs them. This will re-throw errors.

Field Summary

Fields

Modifier and Type	Field and Description
private TikaConfig	config
private ContentHandlerFactory	contentHandlerFactory
private OutputStreamFactory	fsOSFactory
private java.lang.String	outputEncoding
private boolean	parseRecursively
private ParserFactory	parserFactory

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

ELAPSED_MILLIS, IO_IS, IO_OS, LOG, OOM, PARSE_ERR, PARSE_EX, TIMED_OUT

Constructor Summary

Constructors

Constructor and Description
BasicTikaFSConsumer(java.util.concurrent.ArrayBlockingQueue<FileResource> queue, ParserFactory parserFactory, ContentHandlerFactory contentHandlerFactory, OutputStreamFactory fsOSFactory, TikaConfig config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOutputEncoding()
boolean	processFileResource(FileResource fileResource) Main piece of code that needs to be implemented.
void	setOutputEncoding(java.lang.String outputEncoding)

Methods inherited from class org.apache.tika.batch.fs.AbstractFSConsumer

getInputStream, getOutputStream

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

call, checkForTimedOutMillis, close, flushAndClose, getCurrentFile, getNumHandledExceptions, getNumResourcesConsumed, getXMLifiedLogMsg, getXMLifiedLogMsg, incrementHandledExceptions, isStillActive, parse, pleaseShutdown

Methods inherited from class java.lang.Object

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

Field Detail

parseRecursively

private boolean parseRecursively

parserFactory

private final ParserFactory parserFactory

contentHandlerFactory

private final ContentHandlerFactory contentHandlerFactory

fsOSFactory

private final OutputStreamFactory fsOSFactory

config

private final TikaConfig config

outputEncoding

private java.lang.String outputEncoding

Constructor Detail

BasicTikaFSConsumer

public BasicTikaFSConsumer(java.util.concurrent.ArrayBlockingQueue<FileResource> queue,
                           ParserFactory parserFactory,
                           ContentHandlerFactory contentHandlerFactory,
                           OutputStreamFactory fsOSFactory,
                           TikaConfig config)

Method Detail

processFileResource

public boolean processFileResource(FileResource fileResource)

Description copied from class: FileResourceConsumer

Main piece of code that needs to be implemented. Clients are responsible for closing streams and handling the exceptions that they'd like to handle.

Unchecked throwables can be thrown past this, of course. When an unchecked throwable is thrown, this logs the error, and then rethrows the exception. Clients/subclasses should make sure to catch and handle everything they can.

The design goal is that the whole process should close up and shutdown soon after an unchecked exception or error is thrown.

Make sure to call FileResourceConsumer.incrementHandledExceptions() appropriately in your implementation of this method.

Specified by:

processFileResource in class FileResourceConsumer

Parameters:

fileResource - resource to process

Returns:

whether or not a file was successfully processed

getOutputEncoding

public java.lang.String getOutputEncoding()

setOutputEncoding

public void setOutputEncoding(java.lang.String outputEncoding)