com.neurosys.site.components

Class ImageCompressor

java.lang.Object

com.neurosys.site.components.ImageCompressor

public class ImageCompressor
extends Object

Performs image compression

TODO: Thought about shifting class to "domain" JAR instead of keeping in "site". However that would introduce JAI dependencies in domain itself. Also most compression needs are usually for web so keeping in site.
In future if stronger use case for a non web-based app comes then this class can be shifted to domain instead.

It is guaranteed that all apps that depend on site also depend on domain. So in the event of a strong supporting use-case, shifting to domain is no an issue.

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
ImageCompressor(File file) Read original file and replace original file
ImageCompressor(File file, String outPath) Read original file and output as per outPath param

Method Summary

Modifier and Type	Method and Description
protected FileOutputStream	createOutputStream(String outFile)
void	encode() Workhorse method, that does the compression / encoding.
protected void	encodeImage(RenderedImage img, FileOutputStream out)
com.sun.media.jai.codec.ImageEncodeParam	getDefaultCompressionEncodingParam(Float quality) Generate a default encoding param that will be used over the image.
com.sun.media.jai.codec.ImageEncodeParam	getEncodeParam()
String	getFormat()
String	getOutPath()
void	setEncodeParam(com.sun.media.jai.codec.ImageEncodeParam encodeParam)
void	setFormat(String format)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageCompressor

public ImageCompressor(File file)

Read original file and replace original file

Parameters:

file -

ImageCompressor

public ImageCompressor(File file,
                       String outPath)

Read original file and output as per outPath param

Parameters:

file -

outPath -

Method Detail

encodeImage

protected final void encodeImage(RenderedImage img,
                                 FileOutputStream out)

createOutputStream

protected final FileOutputStream createOutputStream(String outFile)

getDefaultCompressionEncodingParam

public com.sun.media.jai.codec.ImageEncodeParam getDefaultCompressionEncodingParam(Float quality)

Generate a default encoding param that will be used over the image.

Parameters:

quality - as float (0 to 1) where 0 is lowest and 1 is highest quality.

Returns:

ImageEncodeParam @default JPEGEncodeParam

Can be null:

true

Default value:

0.4F

encode

public void encode()
            throws IOException

Workhorse method, that does the compression / encoding.

Throws:

IOException

getEncodeParam

public com.sun.media.jai.codec.ImageEncodeParam getEncodeParam()

setEncodeParam

public void setEncodeParam(com.sun.media.jai.codec.ImageEncodeParam encodeParam)

getOutPath

public String getOutPath()

getFormat

public String getFormat()

setFormat

public void setFormat(String format)