org.apache.pdfbox.jbig2.segments

Class PatternDictionary

java.lang.Object

org.apache.pdfbox.jbig2.segments.PatternDictionary

All Implemented Interfaces:

Dictionary, SegmentData

public class PatternDictionary
extends Object
implements Dictionary

This class represents the segment type "Pattern dictionary", 7.4.4.

Constructor Summary

Constructors

Constructor and Description
PatternDictionary()

Method Summary

Modifier and Type	Method and Description
ArrayList<Bitmap>	getDictionary() This method decodes a pattern dictionary segment and returns an array of Bitmap s.
protected int	getGrayMax()
protected short	getHdpHeight()
protected short	getHdpWidth()
protected byte	getHdTemplate()
void	init(SegmentHeader header, SubInputStream sis) Parse the stream and read information of header.
protected boolean	isMMREncoded()

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternDictionary

public PatternDictionary()

Method Detail

getDictionary

public ArrayList<Bitmap> getDictionary()
                                throws IOException,
                                       InvalidHeaderValueException

This method decodes a pattern dictionary segment and returns an array of Bitmap s. Each of this Bitmaps is a pattern.
The procedure is described in 6.7.5 (page 43).

Specified by:

getDictionary in interface Dictionary

Returns:

An array of Bitmaps as result of the decoding procedure.

Throws:

IOException - if an underlying IO operation fails

InvalidHeaderValueException - if the segment header value is invalid

init

public void init(SegmentHeader header,
                 SubInputStream sis)
          throws InvalidHeaderValueException,
                 IOException

Description copied from interface: SegmentData

Parse the stream and read information of header.

Specified by:

init in interface SegmentData

Parameters:

header - - The segments' header (to make referred-to segments available in data part).

sis - - Wrapped ImageInputStream into SubInputStream.

Throws:

InvalidHeaderValueException - if the segment header value is invalid

IOException - if an underlying IO operation fails

isMMREncoded

protected boolean isMMREncoded()

getHdTemplate

protected byte getHdTemplate()

getHdpWidth

protected short getHdpWidth()

getHdpHeight

protected short getHdpHeight()

getGrayMax

protected int getGrayMax()