Class DocumentAnalyzer.Builder

java.lang.Object

opennlp.tools.document.DocumentAnalyzer.Builder

Enclosing class:

DocumentAnalyzer

public static final class DocumentAnalyzer.Builder
extends Object

Assembles a DocumentAnalyzer from annotators in execution order.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
DocumentAnalyzer.Builder	add(DocumentAnnotator annotator)	Appends an annotator to the pipeline.
DocumentAnalyzer	build()	Validates the pipeline and builds the analyzer.

Methods inherited from class Object

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

Method Details

add

public DocumentAnalyzer.Builder add(DocumentAnnotator annotator)

Appends an annotator to the pipeline.

Parameters:

annotator - The annotator to run after the ones already added. Must not be null.

Returns:

This DocumentAnalyzer.Builder. Never null.

Throws:

IllegalArgumentException - Thrown if annotator is null.

build

public DocumentAnalyzer build()

Validates the pipeline and builds the analyzer.

Returns:

A DocumentAnalyzer. Never null.

Throws:

IllegalArgumentException - Thrown if the pipeline is empty, an annotator requires a layer no earlier annotator provides, or two annotators provide the same layer.