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.

Field Summary

Fields

Modifier and Type	Field	Description
private long	dataHeaderLength
private long	dataHeaderOffset	Segment data structure (only necessary if MMR is used)
private long	dataLength
private long	dataOffset
private short[]	gbAtX
private short[]	gbAtY
private int	grayMax	Largest gray-scale value, 7.4.4.1.4 Value: one less than the number of patterns defined in this pattern dictionary
private short	hdpHeight	Height of the patterns in the pattern dictionary, 7.4.4.1.3
private short	hdpWidth	Width of the patterns in the pattern dictionary, 7.4.4.1.2
private byte	hdTemplate
private boolean	isMMREncoded	Pattern dictionary flags, 7.4.4.1.1
private ArrayList<Bitmap>	patterns	Decoded bitmaps, stored to be used by segments, that refer to it
private SubInputStream	subInputStream

Constructor Summary

Constructors

Constructor	Description
PatternDictionary()

Method Summary

Modifier and Type	Method	Description
private void	checkInput()
private void	computeSegmentDataStructure()
private void	extractPatterns(Bitmap collectiveBitmap)
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()
private void	parseHeader()
private void	readGrayMax()
private void	readIsMMREncoded()
private void	readPatternWidthAndHeight()
private void	readTemplate()
private void	setGbAtPixels()

Methods inherited from class Object

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

Field Details

subInputStream

private SubInputStream subInputStream

dataHeaderOffset

private long dataHeaderOffset

Segment data structure (only necessary if MMR is used)

dataHeaderLength

private long dataHeaderLength

dataOffset

private long dataOffset

dataLength

private long dataLength

gbAtX

private short[] gbAtX

gbAtY

private short[] gbAtY

isMMREncoded

private boolean isMMREncoded

Pattern dictionary flags, 7.4.4.1.1

hdTemplate

private byte hdTemplate

hdpWidth

private short hdpWidth

Width of the patterns in the pattern dictionary, 7.4.4.1.2

hdpHeight

private short hdpHeight

Height of the patterns in the pattern dictionary, 7.4.4.1.3

patterns

private ArrayList<Bitmap> patterns

Decoded bitmaps, stored to be used by segments, that refer to it

grayMax

private int grayMax

Largest gray-scale value, 7.4.4.1.4 Value: one less than the number of patterns defined in this pattern dictionary

Constructor Details

PatternDictionary

public PatternDictionary()

Method Details

parseHeader

private void parseHeader()
                  throws IOException,
InvalidHeaderValueException

Throws:

IOException

InvalidHeaderValueException

readTemplate

private void readTemplate()
                   throws IOException

Throws:

IOException

readIsMMREncoded

private void readIsMMREncoded()
                       throws IOException

Throws:

IOException

readPatternWidthAndHeight

private void readPatternWidthAndHeight()
                                throws IOException

Throws:

IOException

readGrayMax

private void readGrayMax()
                  throws IOException

Throws:

IOException

computeSegmentDataStructure

private void computeSegmentDataStructure()
                                  throws IOException

Throws:

IOException

checkInput

private void checkInput()
                 throws InvalidHeaderValueException

Throws:

InvalidHeaderValueException

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

extractPatterns

private void extractPatterns(Bitmap collectiveBitmap)

setGbAtPixels

private void setGbAtPixels()

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()