Package com.norconex.importer.handler.transformer.impl

Class ImageTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.ImageTransformer

All Implemented Interfaces:

Configurable<ImageTransformerConfig>, ConfigurableDocHandler<ImageTransformerConfig>, DocHandler

public class ImageTransformer
extends Object
implements ConfigurableDocHandler<ImageTransformerConfig>

Transforms an image using common image operations.

This class should only be used as a pre-parsing handler, on image files. It may also be appropriate to disable parsing of those images if you want to keep the transformed version intact. This can be done by configuring DefaultParser as a handler in the ImporterConfig.

Content-types

By default, this filter is restricted to (applies only to) documents matching the restrictions returned by CommonRestrictions.imageIOStandardContentTypes(String). You can specify your own content types if you know they represent a supported image.

Image dimension format

For a list of supported image dimension formats, refer to DimensionConverter.

Usage example:

The above example converts images to PNG while scaling it to a maximum dimension of 400 pixels wide and 250 pixel high.

See Also:

• ImageTransformer configuration reference

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Fields inherited from interface com.norconex.importer.handler.DocHandler

NAME

Constructor Summary

Constructors

Constructor	Description
ImageTransformer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ImageTransformerConfig	getConfiguration()
boolean	handle(DocHandlerContext docCtx)	Perform any operations on a document.
int	hashCode()
String	toString()
void	transformImage(MutableImage image)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.norconex.importer.handler.DocHandler

close, init

Constructor Details

ImageTransformer

public ImageTransformer()

Method Details

handle

public boolean handle(DocHandlerContext docCtx)
               throws IOException

Description copied from interface: DocHandler

Perform any operations on a document.

Specified by:

handle in interface DocHandler

Parameters:

docCtx - the document handling context

Returns:

false to stop processing and reject a document or true to proceed to the next configured handler.

Throws:

IOException - An I/O exception of some sort has occurred

transformImage

public void transformImage(MutableImage image)

getConfiguration

public ImageTransformerConfig getConfiguration()

Specified by:

getConfiguration in interface Configurable<ImageTransformerConfig>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object