Package org.springframework.ai.reader.pdf

Class ParagraphPdfDocumentReader

java.lang.Object

org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

All Implemented Interfaces:

Supplier<List<Document>>, DocumentReader

public class ParagraphPdfDocumentReader
extends Object
implements DocumentReader

Uses the PDF catalog (e.g. TOC) information to split the input PDF into text paragraphs and output a single Document per paragraph. This class provides methods for reading and processing PDF documents. It uses the Apache PDFBox library for parsing PDF content and converting it into text paragraphs. The paragraphs are grouped into Document objects.

Author:

Christian Tzolov

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.pdfbox.pdmodel.PDDocument	document
protected String	resourceFileName

Constructor Summary

Constructors

Constructor	Description
ParagraphPdfDocumentReader(String resourceUrl)	Constructs a ParagraphPdfDocumentReader using a resource URL.
ParagraphPdfDocumentReader(String resourceUrl, PdfDocumentReaderConfig config)	Constructs a ParagraphPdfDocumentReader using a resource URL and a configuration.
ParagraphPdfDocumentReader(org.springframework.core.io.Resource pdfResource)	Constructs a ParagraphPdfDocumentReader using a resource.
ParagraphPdfDocumentReader(org.springframework.core.io.Resource pdfResource, PdfDocumentReaderConfig config)	Constructs a ParagraphPdfDocumentReader using a resource and a configuration.

Method Summary

Modifier and Type	Method	Description
protected void	addMetadata(ParagraphManager.Paragraph from, ParagraphManager.Paragraph to, Document document)
List<Document>	get()	Reads and processes the PDF document to extract paragraphs.
String	getTextBetweenParagraphs(ParagraphManager.Paragraph fromParagraph, ParagraphManager.Paragraph toParagraph)
protected Document	toDocument(ParagraphManager.Paragraph from, ParagraphManager.Paragraph to)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.document.DocumentReader

read

Field Details

document

protected final org.apache.pdfbox.pdmodel.PDDocument document

resourceFileName

protected String resourceFileName

Constructor Details

ParagraphPdfDocumentReader

public ParagraphPdfDocumentReader(String resourceUrl)

Constructs a ParagraphPdfDocumentReader using a resource URL.

Parameters:

resourceUrl - The URL of the PDF resource.

ParagraphPdfDocumentReader

public ParagraphPdfDocumentReader(org.springframework.core.io.Resource pdfResource)

Constructs a ParagraphPdfDocumentReader using a resource.

Parameters:

pdfResource - The PDF resource.

ParagraphPdfDocumentReader

public ParagraphPdfDocumentReader(String resourceUrl,
 PdfDocumentReaderConfig config)

Constructs a ParagraphPdfDocumentReader using a resource URL and a configuration.

Parameters:

resourceUrl - The URL of the PDF resource.

config - The configuration for PDF document processing.

ParagraphPdfDocumentReader

public ParagraphPdfDocumentReader(org.springframework.core.io.Resource pdfResource,
 PdfDocumentReaderConfig config)

Constructs a ParagraphPdfDocumentReader using a resource and a configuration.

Parameters:

pdfResource - The PDF resource.

config - The configuration for PDF document processing.

Method Details

get

public List<Document> get()

Reads and processes the PDF document to extract paragraphs.

Specified by:

get in interface Supplier<List<Document>>

Returns:

A list of Document objects representing paragraphs.

toDocument

protected Document toDocument(ParagraphManager.Paragraph from,
 ParagraphManager.Paragraph to)

addMetadata

protected void addMetadata(ParagraphManager.Paragraph from,
 ParagraphManager.Paragraph to,
 Document document)

getTextBetweenParagraphs

public String getTextBetweenParagraphs(ParagraphManager.Paragraph fromParagraph,
 ParagraphManager.Paragraph toParagraph)