org.apache.tika.batch.builders

Class BatchProcessBuilder

java.lang.Object

org.apache.tika.batch.builders.BatchProcessBuilder

public class BatchProcessBuilder
extends java.lang.Object

Builds a BatchProcessor from a combination of runtime arguments and the config file.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_QUEUE_SIZE
static java.lang.String	MAX_QUEUE_SIZE_KEY
static java.lang.String	NUM_CONSUMERS_KEY

Constructor Summary

Constructors

Constructor and Description
BatchProcessBuilder()

Method Summary

Modifier and Type	Method and Description
BatchProcess	build(java.io.InputStream is, java.util.Map<java.lang.String,java.lang.String> runtimeAttributes) Builds a BatchProcess from runtime arguments and a input stream of a configuration file.
BatchProcess	build(org.w3c.dom.Node docElement, java.util.Map<java.lang.String,java.lang.String> incomingRuntimeAttributes) Builds a FileResourceBatchProcessor from runtime arguments and a document node of a configuration file.
private ConsumersManager	buildConsumersManager(org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.String> runtimeAttributes, java.util.concurrent.ArrayBlockingQueue<FileResource> queue)
private FileResourceCrawler	buildCrawler(java.util.concurrent.ArrayBlockingQueue<FileResource> queue, org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)
private Interrupter	buildInterrupter(org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)
private java.util.concurrent.ArrayBlockingQueue<FileResource>	buildQueue(org.w3c.dom.Node docElement, java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)
private StatusReporter	buildReporter(FileResourceCrawler crawler, ConsumersManager consumersManager, org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)
static int	getNumConsumers(java.util.Map<java.lang.String,java.lang.String> attrs) numConsumers is needed by both the crawler and the consumers.
private java.util.Map<java.lang.String,java.lang.String>	setNumConsumersInRuntimeAttributes(org.w3c.dom.Node docElement, java.util.Map<java.lang.String,java.lang.String> incomingRuntimeAttributes)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_QUEUE_SIZE

public static final int DEFAULT_MAX_QUEUE_SIZE

See Also:

Constant Field Values

MAX_QUEUE_SIZE_KEY

public static final java.lang.String MAX_QUEUE_SIZE_KEY

See Also:

Constant Field Values

NUM_CONSUMERS_KEY

public static final java.lang.String NUM_CONSUMERS_KEY

See Also:

Constant Field Values

Constructor Detail

BatchProcessBuilder

public BatchProcessBuilder()

Method Detail

build

public BatchProcess build(java.io.InputStream is,
                          java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)
                   throws java.io.IOException

Builds a BatchProcess from runtime arguments and a input stream of a configuration file. With the exception of the QueueBuilder, the builders choose how to adjudicate between runtime arguments and the elements in the configuration file.

This does not close the InputStream!

Parameters:

is - inputStream

runtimeAttributes - incoming runtime attributes

Returns:

batch process

Throws:

java.io.IOException

build

public BatchProcess build(org.w3c.dom.Node docElement,
                          java.util.Map<java.lang.String,java.lang.String> incomingRuntimeAttributes)

Builds a FileResourceBatchProcessor from runtime arguments and a document node of a configuration file. With the exception of the QueueBuilder, the builders choose how to adjudicate between runtime arguments and the elements in the configuration file.

Parameters:

docElement - document element of the xml config file

incomingRuntimeAttributes - runtime arguments

Returns:

FileResourceBatchProcessor

buildInterrupter

private Interrupter buildInterrupter(org.w3c.dom.Node node,
                                     java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)

buildReporter

private StatusReporter buildReporter(FileResourceCrawler crawler,
                                     ConsumersManager consumersManager,
                                     org.w3c.dom.Node node,
                                     java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)

getNumConsumers

public static int getNumConsumers(java.util.Map<java.lang.String,java.lang.String> attrs)

numConsumers is needed by both the crawler and the consumers. This utility method is to be used to extract the number of consumers from a map of String key value pairs.

If the value is "default", not a parseable integer or has a value < 1, then AbstractConsumersBuilder's getDefaultNumConsumers()

Parameters:

attrs - attributes from which to select the NUM_CONSUMERS_KEY

Returns:

number of consumers

setNumConsumersInRuntimeAttributes

private java.util.Map<java.lang.String,java.lang.String> setNumConsumersInRuntimeAttributes(org.w3c.dom.Node docElement,
                                                                                            java.util.Map<java.lang.String,java.lang.String> incomingRuntimeAttributes)

buildQueue

private java.util.concurrent.ArrayBlockingQueue<FileResource> buildQueue(org.w3c.dom.Node docElement,
                                                                         java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)

buildConsumersManager

private ConsumersManager buildConsumersManager(org.w3c.dom.Node node,
                                               java.util.Map<java.lang.String,java.lang.String> runtimeAttributes,
                                               java.util.concurrent.ArrayBlockingQueue<FileResource> queue)

buildCrawler

private FileResourceCrawler buildCrawler(java.util.concurrent.ArrayBlockingQueue<FileResource> queue,
                                         org.w3c.dom.Node node,
                                         java.util.Map<java.lang.String,java.lang.String> runtimeAttributes)