org.jahia.services.image

Class ImageJAndJava2DImageService

java.lang.Object

org.jahia.services.image.AbstractImageService

org.jahia.services.image.AbstractJava2DImageService

org.jahia.services.image.Java2DProgressiveBilinearImageService

org.jahia.services.image.ImageJAndJava2DImageService

All Implemented Interfaces:

JahiaImageService

public class ImageJAndJava2DImageService
extends Java2DProgressiveBilinearImageService

An image service implementation that combines the Java2D and ImageJ service implementations to expand the supported file formats (such as TIFF)

Nested Class Summary

Nested classes/interfaces inherited from class org.jahia.services.image.AbstractJava2DImageService

AbstractJava2DImageService.OperationType

Nested classes/interfaces inherited from class org.jahia.services.image.AbstractImageService

AbstractImageService.ResizeCoords

Nested classes/interfaces inherited from interface org.jahia.services.image.JahiaImageService

JahiaImageService.ResizeType

Method Summary

Modifier and Type	Method and Description
boolean	createThumb(Image iw, File outputFile, int size, boolean square) Creates an image thumbnail and stores it in a specified file
boolean	cropImage(Image image, File outputFile, int top, int left, int width, int height) Crops an image to a specified file using the specified coordinates Note : due to a bug, the X and Y are reversed, be careful about that !
int	getHeight(Image i) Retrieves the height in pixels of the specified image
Image	getImage(JCRNodeWrapper node) Retrieve the image stored in a JCR node
static ImageJAndJava2DImageService	getInstance()
int	getWidth(Image i) Retrieves the width in pixels of the specified image
void	init()
BufferedImage	resizeImage(BufferedImage image, int width, int height, JahiaImageService.ResizeType resizeType) Resize an image using different types of resize algorithms.
boolean	resizeImage(Image image, File outputFile, int newWidth, int newHeight, JahiaImageService.ResizeType resizeType) Resize an image using different types of resize algorithms.
boolean	rotateImage(Image image, File outputFile, boolean clockwise) Rotate an image clockwise or counter clockwise

Methods inherited from class org.jahia.services.image.Java2DProgressiveBilinearImageService

getGraphics2D

Methods inherited from class org.jahia.services.image.AbstractJava2DImageService

canRead, getDestImage, rotateImage, saveImageToFile

Methods inherited from class org.jahia.services.image.AbstractImageService

getResizeCoords, resizeImage

Methods inherited from class java.lang.Object

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

Method Detail

init

public void init()

getInstance

public static ImageJAndJava2DImageService getInstance()

getImage

public Image getImage(JCRNodeWrapper node)
               throws IOException,
                      javax.jcr.RepositoryException

Description copied from interface: JahiaImageService

Retrieve the image stored in a JCR node

Specified by:

getImage in interface JahiaImageService

Overrides:

getImage in class AbstractJava2DImageService

Parameters:

node - the JCR node that contains the image data.

Returns:

an Image object that usually contains metadata for the other service methods to be able to manipulate the image.

Throws:

IOException

javax.jcr.RepositoryException - in case of JCR-related errors

createThumb

public boolean createThumb(Image iw,
                           File outputFile,
                           int size,
                           boolean square)
                    throws IOException

Description copied from interface: JahiaImageService

Creates an image thumbnail and stores it in a specified file

Specified by:

createThumb in interface JahiaImageService

Overrides:

createThumb in class AbstractImageService

Parameters:

iw - the image for which to generate a thumbnail, this image is loaded through the getImage method

outputFile - the file in which to store the generated thumbnail

size - the size in pixels of the generated thumbnail. Usually this will mean the desired width or height of the image, except if the square option is specified.

square - if false, a ResizeType.ADJUST_SIZE resize will be performed, otherwise if square is true, a ResizeType.ASPECT_FILL will be performed. For more information about these resize types, see the resize method.

Returns:

true if the operation succeeded, false otherwise

Throws:

IOException

getHeight

public int getHeight(Image i)

Description copied from interface: JahiaImageService

Retrieves the height in pixels of the specified image

Specified by:

getHeight in interface JahiaImageService

Overrides:

getHeight in class AbstractJava2DImageService

Parameters:

i - the image for which to retrieve the height

Returns:

the height of the image in pixels

getWidth

public int getWidth(Image i)

Description copied from interface: JahiaImageService

Retrieves the width in pixels of the specified image

Specified by:

getWidth in interface JahiaImageService

Overrides:

getWidth in class AbstractJava2DImageService

Parameters:

i - the image

Returns:

the width in pixels of the image

cropImage

public boolean cropImage(Image image,
                         File outputFile,
                         int top,
                         int left,
                         int width,
                         int height)
                  throws IOException

Description copied from interface: JahiaImageService

Crops an image to a specified file using the specified coordinates Note : due to a bug, the X and Y are reversed, be careful about that !

Specified by:

cropImage in interface JahiaImageService

Overrides:

cropImage in class AbstractJava2DImageService

Parameters:

image - the image to crop

outputFile - the destination file in which to store the cropped image. The file type of the original image is conserved

top - the top Y coordinate at which to start the crop

left - the left X coordinate at which to start the crop

width - the width of the crop region

height - the height of the crop region.

Returns:

true if the cropping succeeded, false otherwise

Throws:

IOException

rotateImage

public boolean rotateImage(Image image,
                           File outputFile,
                           boolean clockwise)
                    throws IOException

Description copied from interface: JahiaImageService

Rotate an image clockwise or counter clockwise

Specified by:

rotateImage in interface JahiaImageService

Overrides:

rotateImage in class AbstractJava2DImageService

Parameters:

image - the image to rotate

outputFile - the file in which to store the rotated image, the original image type is conserved

clockwise - if the true, the image is rotated clockwise, otherwise it is rotated counter clockwise

Returns:

true if the resize succeeded, false otherwise

Throws:

IOException

resizeImage

public boolean resizeImage(Image image,
                           File outputFile,
                           int newWidth,
                           int newHeight,
                           JahiaImageService.ResizeType resizeType)
                    throws IOException

Description copied from interface: JahiaImageService

Resize an image using different types of resize algorithms. Here is a detailed explanation of the different types of resize available : - ResizeType.SCALE_TO_FILL : this is the simplest algorithm. It will simply ignore the original image ratio and scale the image both horizontally and vertically to match the specified width and height. This will usually result in a deformed image and is usually not recommended. - ResizeType.ADJUST_SIZE : in this algorithm the width and height are more considered as desired sizes, but they will be modified to fit the aspect ratio of the original image. Note that the width and height will never be exceeded, so the resulting image will always be smaller than the specified one. - ResizeType.ASPECT_FILL : in this case the resulting image will have the exact specified size, and the image will be resized and cropped (using the center gravity crop) to fill the desired dimension. This will result in some of the image to be removed, but is usually acceptable for profile or icons. - ResizeType.ASPECT_FIT : in this last algorithm the desired image will have the exact specified size and the original image ratio is conserved, but borders will be added to the image to make it match the desired size.

Specified by:

resizeImage in interface JahiaImageService

Overrides:

resizeImage in class Java2DProgressiveBilinearImageService

Parameters:

image - the image to resize

outputFile - the file in which to output the resized image

newWidth - the width of the resized image

newHeight - the height of the resized image

resizeType - the type of resize algorithm to use. Uses a ResizeType enum also available in this interface

Returns:

true if the resize succeeded, false otherwise.

Throws:

IOException

resizeImage

public BufferedImage resizeImage(BufferedImage image,
                                 int width,
                                 int height,
                                 JahiaImageService.ResizeType resizeType)

Description copied from interface: JahiaImageService

Resize an image using different types of resize algorithms.

Specified by:

resizeImage in interface JahiaImageService

Overrides:

resizeImage in class Java2DProgressiveBilinearImageService

Parameters:

image - the image to resize

width - the width of the resized image

height - the height of the resized image

resizeType - the type of resize algorithm to use. Uses a JahiaImageService.ResizeType enum also available in this interface

Returns:

the result image or null in case of a failure

See Also:

for details of the resizing