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

Class PdfDocumentReaderConfig

java.lang.Object

org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

public final class PdfDocumentReaderConfig
extends Object

Common configuration builder for the PagePdfDocumentReader and the ParagraphPdfDocumentReader.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PdfDocumentReaderConfig.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL_PAGES
final int	pageBottomMargin
final ExtractedTextFormatter	pageExtractedTextFormatter
final int	pagesPerDocument
final int	pageTopMargin
final boolean	reversedParagraphPosition

Method Summary

Modifier and Type	Method	Description
static PdfDocumentReaderConfig.Builder	builder()	Start building a new configuration.
static PdfDocumentReaderConfig	defaultConfig()	Returns the default config.
boolean	hasPageRanges()	Whether any page ranges are configured.
boolean	isPageSelected(int pageNumber)	Whether the given one-based page number should be read.

Methods inherited from class java.lang.Object

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

Field Details

ALL_PAGES

public static final int ALL_PAGES

See Also:

• Constant Field Values

reversedParagraphPosition

public final boolean reversedParagraphPosition

pagesPerDocument

public final int pagesPerDocument

pageTopMargin

public final int pageTopMargin

pageBottomMargin

public final int pageBottomMargin

pageExtractedTextFormatter

public final ExtractedTextFormatter pageExtractedTextFormatter

Method Details

builder

public static PdfDocumentReaderConfig.Builder builder()

Start building a new configuration.

Returns:

The entry point for creating a new configuration.

defaultConfig

public static PdfDocumentReaderConfig defaultConfig()

Returns the default config.

Returns:

the default config

isPageSelected

public boolean isPageSelected(int pageNumber)

Whether the given one-based page number should be read. When no page ranges are configured every page is read; otherwise a page is read when it falls within any of the configured inclusive ranges.

Parameters:

pageNumber - the one-based page number

Returns:

true if the page should be read

hasPageRanges

public boolean hasPageRanges()

Whether any page ranges are configured. Readers that do not support page ranges can use this to reject such a configuration instead of silently ignoring it.

Returns:

true if at least one page range has been configured