Class DocumentAnalyzer

java.lang.Object

opennlp.tools.document.DocumentAnalyzer

public final class DocumentAnalyzer
extends Object

Runs a fixed sequence of annotators over a text, producing one Document that carries every step's layers.

The pipeline is validated at build time: every annotator's required layers must be provided by an earlier annotator, and no two annotators may provide the same layer, so a misordered or conflicting pipeline fails when it is assembled rather than midway through a document. The analyzer holds no per-call state; it is as thread-safe as the annotators it is built from.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DocumentAnalyzer.Builder	Assembles a DocumentAnalyzer from annotators in execution order.

Method Summary

Modifier and Type	Method	Description
Document	analyze(CharSequence text)	Analyzes a text by running every annotator in order.
static DocumentAnalyzer.Builder	builder()

Methods inherited from class Object

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

Method Details

builder

public static DocumentAnalyzer.Builder builder()

Returns:

A new DocumentAnalyzer.Builder. Never null.

analyze

public Document analyze(CharSequence text)

Analyzes a text by running every annotator in order.

Parameters:

text - The original document text. Must not be null.

Returns:

The annotated Document. Never null.

Throws:

IllegalArgumentException - Thrown if text is null.