Package org.apache.tika.renderer.pdf.poppler

Class PopplerRenderer

java.lang.Object

org.apache.tika.renderer.pdf.poppler.PopplerRenderer

All Implemented Interfaces:

Serializable, SelfConfiguring, Renderer

public class PopplerRenderer
extends Object
implements Renderer

Renders PDF pages through Poppler's pdftoppm, one call per page at the dpi the RenderSettings the parse scoped (else this renderer's own) resolve to for that page: the target dpi, lowered so the page fits the box and its long side stays within maxScaleTo, never raised. A page over maxImagePixels is skipped with a warning. Page sizes come from the PDDocument the parser leaves as the stream's open container, else from a load of the file.

Poppler is pre-installed on most Linux distributions and is the fastest widely-available PDF renderer. On macOS it can be installed via brew install poppler; on Windows via MSYS2 or Chocolatey.

Configuration key: "poppler-renderer"

Since:

Apache Tika 4.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PopplerRenderer()

Method Summary

Modifier and Type	Method	Description
int	getDpi()
int	getMaxScaleTo()
String	getPdftoppmPath()
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this renderer when used with the given parse context.
int	getTimeoutMillis()
boolean	isGray()
RenderResults	render(TikaInputStream tis, Metadata metadata, ParseContext parseContext, RenderRequest... requests)
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	setGray(boolean gray)	Deprecated. since 4.1.0; see setDpi(int): pages.render.imageType.
void	setMaxScaleTo(int maxScaleTo)	Longest side of a rendered page in pixels; 4096 by default, -1 for none.
void	setPdftoppmPath(String pdftoppmPath)	The pdftoppm executable; "pdftoppm" (on the path) by default.
void	setTimeoutMillis(int timeoutMillis)	Timeout for one pdftoppm call (one page); 120000 by default.

Methods inherited from class java.lang.Object

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

Constructor Details

PopplerRenderer

public PopplerRenderer()

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(TikaInputStream tis,
 Metadata metadata,
 ParseContext parseContext,
 RenderRequest... requests)
                     throws IOException,
TikaException

Specified by:

render in interface Renderer

Throws:

IOException

TikaException

getPdftoppmPath

public String getPdftoppmPath()

setPdftoppmPath

public void setPdftoppmPath(String pdftoppmPath)

The pdftoppm executable; "pdftoppm" (on the path) by default.

getDpi

public int getDpi()

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 this. Configure "pages": {"render": {"dpi": ...}}.

isGray

public boolean isGray()

setGray

@Deprecated
public void setGray(boolean gray)

Deprecated.

since 4.1.0; see setDpi(int): pages.render.imageType.

getTimeoutMillis

public int getTimeoutMillis()

setTimeoutMillis

public void setTimeoutMillis(int timeoutMillis)

Timeout for one pdftoppm call (one page); 120000 by default.

getMaxScaleTo

public int getMaxScaleTo()

setMaxScaleTo

public void setMaxScaleTo(int maxScaleTo)

Longest side of a rendered page in pixels; 4096 by default, -1 for none.