Package org.apache.tika.renderer.microsoft

Class POIMetafileRenderer

java.lang.Object

org.apache.tika.renderer.microsoft.POIMetafileRenderer

All Implemented Interfaces:

Serializable, SelfConfiguring, Renderer

public class POIMetafileRenderer
extends Object
implements Renderer

Renders EMF and WMF images to a raster image through POI's HEMF and HWMF, the way PDFBoxRenderer renders PDF pages: at the RenderSettings the parse scopes into the context (dpi, box, colour, format), else this renderer's own, on a white canvas with the picture's aspect ratio; a canvas over maxImagePixels is refused. Metafiles have no pages, so the render requests are ignored and a single result is returned.

The WMF thumbnails that Word stores in the SummaryInformation of a .doc consist of a window extent and a single dibStretchBlt record, for which POI cannot compute bounds; those are rendered from the record's bitmap directly.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final MediaType	EMF
static final String	RENDERED_BY
static final MediaType	WMF

Constructor Summary

Constructors

Constructor	Description
POIMetafileRenderer()

Method Summary

Modifier and Type	Method	Description
String	getImageFormatName()
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this renderer when used with the given parse context.
int	getWidth()	The width the box allows when the parse scopes no settings; 800 by default.
RenderResults	render(TikaInputStream tis, Metadata metadata, ParseContext parseContext, RenderRequest... requests)	Renders the metafile in the stream, or the HemfPicture or HwmfPicture set as the stream's open container.
void	setImageFormatName(String imageFormatName)	Deprecated. since 4.1.0; see setWidth(int): pages.render.imageFormat.
void	setWidth(int width)	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.

Methods inherited from class java.lang.Object

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

Field Details

RENDERED_BY

public static final String RENDERED_BY

See Also:

• Constant Field Values

EMF

public static final MediaType EMF

WMF

public static final MediaType WMF

Constructor Details

POIMetafileRenderer

public POIMetafileRenderer()

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

Renders the metafile in the stream, or the HemfPicture or HwmfPicture set as the stream's open container. The metadata's TikaCoreProperties.TYPE tells EMF from WMF when a stream is parsed; it defaults to EMF.

Specified by:

render in interface Renderer

Throws:

IOException

TikaException

getWidth

public int getWidth()

The width the box allows when the parse scopes no settings; 800 by default.

setWidth

@Deprecated
public void setWidth(int width)

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. The EMF/WMF parsers always scope pages.render (300 dpi of the drawing's physical size, grayscale PNG, unless the block says otherwise), which replaces this. Configure "pages": {"render": {"maxWidth": ...}}.

getImageFormatName

public String getImageFormatName()

setImageFormatName

@Deprecated
public void setImageFormatName(String imageFormatName)

Deprecated.

since 4.1.0; see setWidth(int): pages.render.imageFormat.