com.day.cq.dam.commons.util

Class WebEnabledImageCreator

java.lang.Object

com.day.cq.dam.commons.util.WebEnabledImageCreator

public class WebEnabledImageCreator
extends java.lang.Object

The WebEnabledImageCreator class provides all functionality in order to create a web enabled image.

Constructor Summary

Constructors

Constructor and Description
WebEnabledImageCreator(Asset asset, MimeTypeService mimeTypeService)

Method Summary

Methods

Modifier and Type	Method and Description
void	create(java.awt.image.BufferedImage image, java.lang.String defaultMimetype, java.lang.String dimensions, java.lang.String keepFormat, java.lang.String qualityStr, boolean force) This method creates the web enabled rendition.
protected Layer	createImage(java.awt.image.BufferedImage image, int maxWidth, int maxHeight) A image with the given maxWith and maxHeight is generated out if the image source.
protected java.lang.Integer[]	getDimension(java.lang.String dimensions)
protected java.lang.String	getExtension(java.lang.String mimetype)
protected java.lang.String	getMimeType(Asset asset)
protected double	getQuality(double base, java.lang.String qualityStr)
protected void	saveImage(Asset asset, Layer layer, java.lang.String mimetype, double quality, java.lang.String renditionName)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebEnabledImageCreator

public WebEnabledImageCreator(Asset asset,
                      MimeTypeService mimeTypeService)

Method Detail

create

public void create(java.awt.image.BufferedImage image,
          java.lang.String defaultMimetype,
          java.lang.String dimensions,
          java.lang.String keepFormat,
          java.lang.String qualityStr,
          boolean force)
            throws RepositoryException,
                   java.io.IOException

This method creates the web enabled rendition. if the force param is set to false than following check is executed: check if layer has to persisted. in case the layer is still equal than the ori file can be taken (save space).

Parameters:

image - buffered image used to create web enabled image

defaultMimetype - default output mimetype

dimensions - comma separated string containing max. with, max. height

keepFormat - contains all mimetypes that should be kept (instead of using the default mimetype)

qualityStr - image quality in percent

force - if true than the webenabled image is always created nevertheless the ori image is smaller than the requested image dimensions

Throws:

RepositoryException - in case the web rendition could not be persisted

java.io.IOException - while processing the image

saveImage

protected void saveImage(Asset asset,
             Layer layer,
             java.lang.String mimetype,
             double quality,
             java.lang.String renditionName)
                  throws java.io.IOException

Throws:

java.io.IOException

createImage

protected Layer createImage(java.awt.image.BufferedImage image,
                int maxWidth,
                int maxHeight)

A image with the given maxWith and maxHeight is generated out if the image source.

Parameters:

image - image source

maxWidth - max. thumbnail width

maxHeight - max. thumbnail height

Returns:

the resized image layer

getExtension

protected java.lang.String getExtension(java.lang.String mimetype)

getMimeType

protected java.lang.String getMimeType(Asset asset)

getDimension

protected java.lang.Integer[] getDimension(java.lang.String dimensions)

getQuality

protected double getQuality(double base,
                java.lang.String qualityStr)