Package org.springframework.ai.reader.pdf

Class PagePdfDocumentReader

java.lang.Object

org.springframework.ai.reader.pdf.PagePdfDocumentReader

All Implemented Interfaces:

Supplier<List<Document>>, DocumentReader

public class PagePdfDocumentReader
extends Object
implements DocumentReader

Groups the parsed PDF pages into Documents. You can group one or more pages into a single output document. Use PdfDocumentReaderConfig for customization options. The default configuration is: - pagesPerDocument = 1 - pageTopMargin = 0 - pageBottomMargin = 0

Author:

Christian Tzolov

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
PagePdfDocumentReader(String resourceUrl)
PagePdfDocumentReader(String resourceUrl, PdfDocumentReaderConfig config)
PagePdfDocumentReader(org.springframework.core.io.Resource pdfResource)
PagePdfDocumentReader(org.springframework.core.io.Resource pdfResource, PdfDocumentReaderConfig config)

Method Summary

Modifier and Type	Method	Description
List<Document>	get()
protected Document	toDocument(org.apache.pdfbox.pdmodel.PDPage page, String docText, int startPageNumber, int endPageNumber)

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

METADATA_START_PAGE_NUMBER

public static final String METADATA_START_PAGE_NUMBER

See Also:

• Constant Field Values

METADATA_END_PAGE_NUMBER

public static final String METADATA_END_PAGE_NUMBER

See Also:

• Constant Field Values

METADATA_FILE_NAME

public static final String METADATA_FILE_NAME

See Also:

• Constant Field Values

document

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

resourceFileName

protected String resourceFileName

Constructor Details

PagePdfDocumentReader

public PagePdfDocumentReader(String resourceUrl)

PagePdfDocumentReader

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

PagePdfDocumentReader

public PagePdfDocumentReader(String resourceUrl,
 PdfDocumentReaderConfig config)

PagePdfDocumentReader

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

Method Details

get

public List<Document> get()

Specified by:

get in interface Supplier<List<Document>>

toDocument

protected Document toDocument(org.apache.pdfbox.pdmodel.PDPage page,
 String docText,
 int startPageNumber,
 int endPageNumber)