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

Class ImageTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.ImageTransformerConfig

All Implemented Interfaces:

Labelable

public class ImageTransformerConfig
extends BaseDocHandlerConfig

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageTransformerConfig.Crop
static class	ImageTransformerConfig.Scale

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TARGET_FORMAT

Constructor Summary

Constructors

Constructor	Description
ImageTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
TextMatcher	getContentTypeMatcher()	The matcher of content types to apply transformation on.
ImageTransformerConfig.Crop	getCrop()
Double	getRotation()
ImageTransformerConfig.Scale	getScale()
String	getTargetFormat()
int	hashCode()
ImageTransformerConfig	setContentTypeMatcher(TextMatcher contentTypeMatcher)	The matcher of content types to apply transformation on.
ImageTransformerConfig	setRotation(Double rotation)
ImageTransformerConfig	setTargetFormat(String targetFormat)
String	toString()

Methods inherited from class com.norconex.importer.handler.BaseLabelableConfig

getLabel, setLabel

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TARGET_FORMAT

public static final String DEFAULT_TARGET_FORMAT

See Also:

• Constant Field Values

Constructor Details

ImageTransformerConfig

public ImageTransformerConfig()

Method Details

setContentTypeMatcher

public ImageTransformerConfig setContentTypeMatcher(TextMatcher contentTypeMatcher)

The matcher of content types to apply transformation on. No attempt to transform documents of any other content types will be made. Default is CommonMatchers.IMAGE_IO_CONTENT_TYPES.

Parameters:

contentTypeMatcher - content type matcher

Returns:

this

getTargetFormat

public String getTargetFormat()

getRotation

public Double getRotation()

getScale

public ImageTransformerConfig.Scale getScale()

getCrop

public ImageTransformerConfig.Crop getCrop()

getContentTypeMatcher

public TextMatcher getContentTypeMatcher()

The matcher of content types to apply transformation on. No attempt to transform documents of any other content types will be made. Default is CommonMatchers.IMAGE_IO_CONTENT_TYPES.

Returns:

content type matcher

setTargetFormat

public ImageTransformerConfig setTargetFormat(String targetFormat)

Returns:

this.

setRotation

public ImageTransformerConfig setRotation(Double rotation)

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseLabelableConfig

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseLabelableConfig

hashCode

public int hashCode()

Overrides:

hashCode in class BaseLabelableConfig

toString

public String toString()

Overrides:

toString in class BaseLabelableConfig