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

Class PDFBoxRenderer

java.lang.Object

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

All Implemented Interfaces:

Serializable, Initializable, PDDocumentRenderer, Renderer

public class PDFBoxRenderer
extends Object
implements PDDocumentRenderer, Initializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	LOG
static 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 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
void	checkInitialization(InitializableProblemHandler problemHandler)
protected int	getDPI(ParseContext parseContext)
protected String	getImageFormatName(ParseContext parseContext)
protected org.apache.pdfbox.rendering.ImageType	getImageType(ParseContext parseContext)
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this renderer when used with the given parse context.
void	initialize(Map<String,Param> params)
RenderResults	render(InputStream is, Metadata metadata, ParseContext parseContext, RenderRequest... requests)
protected RenderResult	renderPage(org.apache.pdfbox.rendering.PDFRenderer renderer, int id, int pageNumber, Metadata metadata, ParseContext parseContext)
void	setDPI(int dpi)
void	setImageFormatName(String imageFormatName)
void	setImageType(org.apache.pdfbox.rendering.ImageType imageType)

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 Property PDFBOX_RENDERING_TIME_MS

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

PDFBOX_IMAGE_WRITING_TIME_MS

public static 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.

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

render

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

Specified by:

render in interface Renderer

Throws:

IOException

TikaException

renderPage

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

Throws:

IOException

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Specified by:

initialize in interface Initializable

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException

setDPI

public void setDPI(int dpi)

setImageType

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

setImageFormatName

public void setImageFormatName(String imageFormatName)

getDPI

protected int getDPI(ParseContext parseContext)

getImageType

protected org.apache.pdfbox.rendering.ImageType getImageType(ParseContext parseContext)

getImageFormatName

protected String getImageFormatName(ParseContext parseContext)