Package org.apache.tika.renderer.pdf.pdfbox

Class PDFBoxRenderer

java.lang.Object

org.apache.tika.renderer.pdf.pdfbox.PDFBoxRenderer

All Implemented Interfaces:

Serializable, SelfConfiguring, PDDocumentRenderer, Renderer

public class PDFBoxRenderer
extends Object
implements PDDocumentRenderer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	LOG
static final Property	PDFBOX_IMAGE_WRITING_TIME_MS	This is the amount of time it takes for PDFBox/java to write the image after it has been rendered into a BufferedImage.
static final Property	PDFBOX_RENDERING_TIME_MS	This is the amount of time it takes for PDFBox to render the page to a BufferedImage

Constructor Summary

Constructors

Constructor	Description
PDFBoxRenderer()

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this renderer when used with the given parse context.
static double[]	pageSize(org.apache.pdfbox.pdmodel.PDPage page)	The size in points of the image PDFBox draws for the page: the crop box, with width and height swapped when the page is rotated a quarter turn.
RenderResults	render(TikaInputStream tis, Metadata metadata, ParseContext parseContext, RenderRequest... requests)
protected RenderResult	renderPage(org.apache.pdfbox.rendering.PDFRenderer renderer, org.apache.pdfbox.pdmodel.PDPage page, int id, int pageNumber, Metadata metadata, ParseContext parseContext)
void	setDPI(int dpi)	Deprecated. since 4.1.0: applies only to a direct render(org.apache.tika.io.TikaInputStream, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext, org.apache.tika.renderer.RenderRequest...) call with no RenderSettings in the context.
void	setImageFormatName(String imageFormatName)	Deprecated. since 4.1.0; see setDPI(int).
void	setImageQuality(float imageQuality)	Deprecated. since 4.1.0; see setDPI(int).
void	setImageType(org.apache.pdfbox.rendering.ImageType imageType)	Deprecated. since 4.1.0; see setDPI(int).
void	setMaxImagePixels(long maxImagePixels)	Deprecated. since 4.1.0; see setDPI(int).
static org.apache.pdfbox.rendering.ImageType	toPdfBox(ImageType imageType)	PDFBox's image type for a core one.

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final org.slf4j.Logger LOG

PDFBOX_RENDERING_TIME_MS

public static final Property PDFBOX_RENDERING_TIME_MS

This is the amount of time it takes for PDFBox to render the page to a BufferedImage

See Also:

• the curated Property this aliases; tk: Properties mint only in org.apache.tika.metadata (see Property mint-time validation)

PDFBOX_IMAGE_WRITING_TIME_MS

public static final Property PDFBOX_IMAGE_WRITING_TIME_MS

This is the amount of time it takes for PDFBox/java to write the image after it has been rendered into a BufferedImage. Some formats take much longer to encode than others.

See Also:

• the curated Property this aliases

Constructor Details

PDFBoxRenderer

public PDFBoxRenderer()

Method Details

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Renderer

Returns the set of media types supported by this renderer when used with the given parse context.

Specified by:

getSupportedTypes in interface Renderer

Parameters:

context - parse context

Returns:

immutable set of media types

toPdfBox

public static org.apache.pdfbox.rendering.ImageType toPdfBox(ImageType imageType)

PDFBox's image type for a core one.

render

public RenderResults render(TikaInputStream tis,
 Metadata metadata,
 ParseContext parseContext,
 RenderRequest... requests)
                     throws IOException,
TikaException

Specified by:

render in interface Renderer

Throws:

IOException

TikaException

pageSize

public static double[] pageSize(org.apache.pdfbox.pdmodel.PDPage page)

The size in points of the image PDFBox draws for the page: the crop box, with width and height swapped when the page is rotated a quarter turn. What the box and minimum apply to.

renderPage

protected RenderResult renderPage(org.apache.pdfbox.rendering.PDFRenderer renderer,
 org.apache.pdfbox.pdmodel.PDPage page,
 int id,
 int pageNumber,
 Metadata metadata,
 ParseContext parseContext)
                           throws IOException

Throws:

IOException

setDPI

@Deprecated
public void setDPI(int dpi)

Deprecated.

since 4.1.0: applies only to a direct render(org.apache.tika.io.TikaInputStream, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext, org.apache.tika.renderer.RenderRequest...) call with no RenderSettings in the context. A parse always scopes pages.render, which replaces every value set here. Configure "pages": {"render": {...}}, or set a RenderSettings on the context when calling the renderer yourself.

setImageType

@Deprecated
public void setImageType(org.apache.pdfbox.rendering.ImageType imageType)

Deprecated.

since 4.1.0; see setDPI(int).

setImageFormatName

@Deprecated
public void setImageFormatName(String imageFormatName)

Deprecated.

since 4.1.0; see setDPI(int).

setImageQuality

@Deprecated
public void setImageQuality(float imageQuality)

Deprecated.

since 4.1.0; see setDPI(int).

setMaxImagePixels

@Deprecated
public void setMaxImagePixels(long maxImagePixels)

Deprecated.

since 4.1.0; see setDPI(int).