org.jahia.services.image

Interface JahiaImageService

All Known Implementing Classes:

AbstractImageService, AbstractJava2DImageService, ImageJAndJava2DImageService, ImageJImageService, ImageMagickImage6Service, ImageMagickImageService, Java2DProgressiveBilinearImageService

public interface JahiaImageService

The main interface for an image generation service implementation. This interface provides access to various image manipulation operations such as image resizing, cropping and rotating.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JahiaImageService.ResizeType The resize type allows to control how the original image will be fitted in the destination size

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 i, 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
int	getWidth(Image i) Retrieves the width in pixels of the specified image
BufferedImage	resizeImage(BufferedImage image, int width, int height, JahiaImageService.ResizeType resizeType) Resize an image using different types of resize algorithms.
boolean	resizeImage(Image i, File outputFile, int width, int height) Resize an image using an ADJUST_SIZE resize type.
boolean	resizeImage(Image i, File outputFile, int width, int height, JahiaImageService.ResizeType resizeType) Resize an image using different types of resize algorithms.
boolean	rotateImage(Image i, File outputFile, boolean clockwise) Rotate an image clockwise or counter clockwise
boolean	rotateImage(Image i, File outputFile, double angle) Rotate an image clockwise or counter clockwise

Method Detail

getImage

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

Retrieve the image stored in a JCR node

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

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

Creates an image thumbnail and stores it in a specified file

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

int getHeight(Image i)
       throws IOException

Retrieves the height in pixels of the specified image

Parameters:

i - the image for which to retrieve the height

Returns:

the height of the image in pixels

Throws:

IOException

getWidth

int getWidth(Image i)
      throws IOException

Retrieves the width in pixels of the specified image

Parameters:

i - the image

Returns:

the width in pixels of the image

Throws:

IOException

cropImage

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

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 !

Parameters:

i - 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

resizeImage

boolean resizeImage(Image i,
                    File outputFile,
                    int width,
                    int height)
             throws IOException

Resize an image using an ADJUST_SIZE resize type. See the other resizeImage method for more details on the resize types

Parameters:

i - the image to resize

outputFile - the output file where to output the resized image

width - the desired image width

height - the desired image height

Returns:

true if the resize succeeded, false otherwise

Throws:

IOException

rotateImage

boolean rotateImage(Image i,
                    File outputFile,
                    boolean clockwise)
             throws IOException

Rotate an image clockwise or counter clockwise

Parameters:

i - 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

rotateImage

boolean rotateImage(Image i,
                    File outputFile,
                    double angle)
             throws IOException

Rotate an image clockwise or counter clockwise

Parameters:

i - the image to rotate

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

angle - angle in degrees counter clockwise

Returns:

true if the resize succeeded, false otherwise

Throws:

IOException

resizeImage

boolean resizeImage(Image i,
                    File outputFile,
                    int width,
                    int height,
                    JahiaImageService.ResizeType resizeType)
             throws IOException

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.

Parameters:

i - the image to resize

outputFile - the file in which to output the resized image

width - the width of the resized image

height - 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

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

Resize an image using different types of resize algorithms.

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

Throws:

IOException

See Also:

for details of the resizing