wjhk.jupload2.filedata.helper

Class ImageReaderWriterHelper

java.lang.Object

wjhk.jupload2.filedata.helper.ImageReaderWriterHelper

public class ImageReaderWriterHelper
extends Object

This package provides low level methods, for picture management. It is used by PictureFileData to simplify its processing.

Author:

etienne_sf

Constructor Summary

Constructors

Constructor and Description
ImageReaderWriterHelper(PictureUploadPolicy uploadPolicy, PictureFileData pictureFileData) Standard constructor.

Method Summary

Modifier and Type	Method and Description
void	dispose() Free all reserved resource by this helper.
IIOMetadata	getImageMetadata(int imageIndex) Load the metadata associated with one picture in the picture file.
int	getNumImages(boolean allowSearch) Call to imageReader.getNumImages(boolean).
String	getTargetPictureFormat() returns the target picture format (lowercase, may be the same as the file extension)
IIOImage	readAll(int imageIndex) Read an image, from the pictureFileData.
BufferedImage	readImage(int imageIndex) Read an image, from the pictureFileData.
void	setOutput(File file) Creates a FileImageOutputStream, and assign it as the output to the imageWriter.
void	write(IIOImage iioImage) Write a picture in the output picture file.
void	writeInsert(int numIndex, IIOImage iioImage, ImageWriteParam iwp) Write a picture in the output picture file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageReaderWriterHelper

public ImageReaderWriterHelper(PictureUploadPolicy uploadPolicy,
                               PictureFileData pictureFileData)

Standard constructor.

Parameters:

uploadPolicy - The current upload policy.

pictureFileData - The file data to be 'helped'.

Method Detail

getTargetPictureFormat

public String getTargetPictureFormat()

returns the target picture format (lowercase, may be the same as the file extension)

Returns:

the target picture format (lowercase, may be the same as the file extension)

setOutput

public void setOutput(File file)
               throws JUploadIOException

Creates a FileImageOutputStream, and assign it as the output to the imageWriter.

Parameters:

file - The file where the output stream must write.

Throws:

JUploadIOException - Any error...

dispose

public void dispose()
             throws JUploadIOException

Free all reserved resource by this helper. Includes closing of any input or output stream.

Throws:

JUploadIOException - Any IO Exception

getNumImages

public int getNumImages(boolean allowSearch)
                 throws JUploadIOException

Call to imageReader.getNumImages(boolean). Caution: may be long, for big files.

Parameters:

allowSearch -

Returns:

The number of image into this file.

Throws:

JUploadIOException

readImage

public BufferedImage readImage(int imageIndex)
                        throws JUploadIOException,
                               IndexOutOfBoundsException

Read an image, from the pictureFileData.

Parameters:

imageIndex - The index number of the picture, in the file. 0 for the first picture (only valid value for picture containing one picture)

Returns:

The image corresponding to this index, in the picture file.

Throws:

JUploadIOException

IndexOutOfBoundsException - Occurs when the imageIndex is wrong.

readAll

public IIOImage readAll(int imageIndex)
                 throws JUploadIOException,
                        IndexOutOfBoundsException

Read an image, from the pictureFileData.

Parameters:

imageIndex - The index number of the picture, in the file. 0 for the first picture (only valid value for picture containing one picture)

Returns:

The full image data for this index

Throws:

JUploadIOException

IndexOutOfBoundsException - Occurs when the imageIndex is wrong.

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws JUploadIOException

Load the metadata associated with one picture in the picture file.

Parameters:

imageIndex -

Returns:

The metadata loaded

Throws:

JUploadIOException - Any IOException is encapsulated in this exception

writeInsert

public void writeInsert(int numIndex,
                        IIOImage iioImage,
                        ImageWriteParam iwp)
                 throws JUploadIOException

Write a picture in the output picture file. Called just before an upload.

Parameters:

numIndex - The index of the image in the transformed picture file.

iioImage - The image to write.

iwp - The parameter to use to write this image.

Throws:

JUploadIOException

write

public void write(IIOImage iioImage)
           throws JUploadIOException

Write a picture in the output picture file. Called just before an upload.

Parameters:

iioImage - The image to write.

Throws:

JUploadIOException