IERImageProcessor Interface Reference

Inherited by ERImageProcessor.

List of all members.

Public Types
enum	Quality { Low, Medium, High }
Public Member Functions
void	processImage (int resizeWidth, int resizeHeight, Quality resizeQuality, int dpi, float sharpenRadius, float sharpenIntensity, float gamma, int cropX, int cropY, int cropWidth, int cropHeight, File watermarkFile, boolean tileWatermark, float compressionQuality, File colorProfileFile, File inputFile, File outputFile, ERMimeType outputMimeType) throws IOException
void	thumbnail (int resizeWidth, int resizeHeight, File inputFile, File outputFile, ERMimeType outputMimeType) throws IOException
void	thumbnail (int resizeWidth, int resizeHeight, File inputFile, File outputFile) throws IOException

---

Detailed Description

Provides an interface for processing an image, performing various operations on it (most commonly, thumbnailing).

Author:

mschrag

---

Member Enumeration Documentation

enum Quality

Quality is an enumerated type used to specify the resize quality.

Author:

mschrag

Enumerator:

Low
Medium
High

---

Member Function Documentation

void processImage	(	int	resizeWidth,
		int	resizeHeight,
		Quality	resizeQuality,
		int	dpi,
		float	sharpenRadius,
		float	sharpenIntensity,
		float	gamma,
		int	cropX,
		int	cropY,
		int	cropWidth,
		int	cropHeight,
		File	watermarkFile,
		boolean	tileWatermark,
		float	compressionQuality,
		File	colorProfileFile,
		File	inputFile,
		File	outputFile,
		ERMimeType	outputMimeType
	)			throws IOException

Processes the given image with all of the given configuration settings.

Order: resize/dpi, colorspace, crop, sharpen, gamma, watermark

Parameters:

	resizeWidth	the maximum width to resize to (or -1 to not specify)
	resizeHeight	the maximum height to resize to (or -1 to not specify)
	resizeQuality	influences the resize algorithm to use (or null to not specify)
	dpi	the dpi to resize to (or -1 to skip)
	sharpenRadius	the radius of the unsharp mask (or <= 0.0 to skip)
	sharpenIntensity	the intensity of the unsharp mask (or <= 0.0 to skip)
	gamma	the gamma to apply (or 0.0 to skip)
	cropX	the x position of the crop (or <= 0 to skip)
	cropY	the y position of the crop (or <= 0 to skip)
	cropWidth	the width of the crop (or <= 0 to skip)
	cropHeight	the height of the crop (or <= 0 to skip)
	watermarkFile	the watermark File to apply to this image (or null to skip)
	tileWatermark	whether or not to tile the watermark
	compressionQuality	the compression quality of the resize to perform (0.0 to ignore) -- range is 0.0 to 1.0 (1.0 = best)
	colorProfileFile	the ICC profile to use (or null to skip)
	inputFile	the File to perform the given operations on
	outputFile	the File to write the resulting output image to
	outputMimeType	the desired mime type of the output file

Exceptions:

IOException

if the image processing fails

Implemented in ImageIOImageProcessor, ImageMagickImageProcessor, Java2DImageProcessor, and SipsImageProcessor.

void thumbnail	(	int	resizeWidth,
		int	resizeHeight,
		File	inputFile,
		File	outputFile,
		ERMimeType	outputMimeType
	)			throws IOException

Provides a shortcut to thumbnailing an image using some default values that produce decent quality thumbnail outputs.

Parameters:

	resizeWidth	the maximum resize width
	resizeHeight	the maximum resize height
	inputFile	the input file to thumbnail
	outputFile	the output file to write the thumbnail into
	outputMimeType	the output mime type

Exceptions:

IOException

if the thumbnailing fails

Implemented in ERImageProcessor.

void thumbnail	(	int	resizeWidth,
		int	resizeHeight,
		File	inputFile,
		File	outputFile
	)			throws IOException

Provides a shortcut to thumbnailing an image using some default values that produce decent quality thumbnail outputs.

Parameters:

	resizeWidth	the maximum resize width
	resizeHeight	the maximum resize height
	inputFile	the input file to thumbnail
	outputFile	the output file to write the thumbnail into

Exceptions:

IOException

if the thumbnailing fails

Implemented in ERImageProcessor.

---

The documentation for this interface was generated from the following file:

• /opt/source/Wonder/Frameworks/BusinessLogic/ERAttachment/Sources/er/attachment/thumbnail/IERImageProcessor.java