Package org.springframework.ai.reader.pdf.config

Class ParagraphManager

java.lang.Object

org.springframework.ai.reader.pdf.config.ParagraphManager

public class ParagraphManager
extends Object

The ParagraphManager class is responsible for managing the paragraphs and hierarchy of a PDF document. It can process bookmarks and generate a structured tree of paragraphs, representing the table of contents (TOC) of the PDF document.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ParagraphManager.Paragraph	Represents a document paragraph metadata and hierarchy.

Constructor Summary

Constructors

Constructor	Description
ParagraphManager(org.apache.pdfbox.pdmodel.PDDocument document)

Method Summary

Modifier and Type	Method	Description
List<ParagraphManager.Paragraph>	flatten()
protected ParagraphManager.Paragraph	generateParagraphs(ParagraphManager.Paragraph parentParagraph, org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode bookmark, Integer level)	For given PDOutlineNode bookmark convert all sibling PDOutlineItem items into ParagraphManager.Paragraph instances under the parentParagraph.
List<ParagraphManager.Paragraph>	getParagraphsByLevel(ParagraphManager.Paragraph paragraph, int level, boolean interLevelText)

Methods inherited from class java.lang.Object

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

Constructor Details

ParagraphManager

public ParagraphManager(org.apache.pdfbox.pdmodel.PDDocument document)

Method Details

flatten

public List<ParagraphManager.Paragraph> flatten()

generateParagraphs

protected ParagraphManager.Paragraph generateParagraphs(ParagraphManager.Paragraph parentParagraph,
 org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode bookmark,
 Integer level)
                                                 throws IOException

For given PDOutlineNode bookmark convert all sibling PDOutlineItem items into ParagraphManager.Paragraph instances under the parentParagraph. For each PDOutlineItem item, recursively call generateParagraphs(org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph, org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode, java.lang.Integer) to process its children items.

Parameters:

parentParagraph - Root paragraph that the bookmark sibling items should be added to.

bookmark - TOC paragraphs to process.

level - Current TOC deepness level.

Returns:

Returns a tree of ParagraphManager.Paragraphs that represent the PDF document TOC.

Throws:

IOException

getParagraphsByLevel

public List<ParagraphManager.Paragraph> getParagraphsByLevel(ParagraphManager.Paragraph paragraph,
 int level,
 boolean interLevelText)