Module org.sejda.sambox

Package org.sejda.sambox.filter

Class JPXFilter

java.lang.Object

org.sejda.sambox.filter.Filter

org.sejda.sambox.filter.JPXFilter

public final class JPXFilter
extends Filter

Decompress data encoded using the wavelet-based JPEG 2000 standard, reproducing the original data. Requires the Java Advanced Imaging (JAI) Image I/O Tools to be installed from java.net, see jai-imageio. Alternatively you can build from the source available in the jai-imageio-core svn repo. Mac OS X users should download the tar.gz file for linux and unpack it to obtain the required jar files. The .so file can be safely ignored.

Author:

John Hewson, Timo Boehme

Field Summary

Fields inherited from class org.sejda.sambox.filter.Filter

SYSPROP_DEFLATELEVEL

Constructor Summary

Constructors

Constructor	Description
JPXFilter()

Method Summary

Modifier and Type	Method	Description
DecodeResult	decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index)	Decodes data, producing the original non-encoded data.
void	encode(InputStream input, OutputStream encoded, COSDictionary parameters)	Encodes data.

Methods inherited from class org.sejda.sambox.filter.Filter

findImageReader, getCompressionLevel, getDecodeParams

Methods inherited from class java.lang.Object

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

Constructor Details

JPXFilter

public JPXFilter()

Method Details

decode

public DecodeResult decode(InputStream encoded,
 OutputStream decoded,
 COSDictionary parameters,
 int index)
                    throws IOException

Decodes data, producing the original non-encoded data.

Specified by:

decode in class Filter

Parameters:

encoded - the encoded byte stream

decoded - the stream where decoded data will be written

parameters - the parameters used for decoding

index - the index to the filter being decoded

Returns:

repaired parameters dictionary, or the original parameters dictionary

Throws:

IOException - if the stream cannot be decoded

encode

public void encode(InputStream input,
 OutputStream encoded,
 COSDictionary parameters)

Encodes data.

Specified by:

encode in class Filter

Parameters:

input - the byte stream to encode

encoded - the stream where encoded data will be written

parameters - the parameters used for encoding