Apache PDFBox 3.0.4 · org.apache.pdfbox.jbig2.segments.PatternDictionary

Field Summary

Modifier and Type	Field and 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

Access	Constructor and Description
public	PatternDictionary()

Method Summary

Modifier and Type	Method and Description
private void	checkInput()
private void	computeSegmentDataStructure()
private void	extractPatterns(Bitmap collectiveBitmap)
public ArrayList<Bitmap>	Returns: An array of `Bitmap`s as result of the decoding procedure. getDictionary() Implements org.apache.pdfbox.jbig2.Dictionary.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()
public void	init(SegmentHeader - The segments' header (to make referred-to segments available in data part). header, SubInputStream - Wrapped `ImageInputStream` into `SubInputStream`. sis) Implements org.apache.pdfbox.jbig2.SegmentData.init. 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()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dataHeaderLength	back to summary
private long dataHeaderLength

dataHeaderOffset	back to summary
private long dataHeaderOffset Segment data structure (only necessary if MMR is used)

dataLength	back to summary
private long dataLength

dataOffset	back to summary
private long dataOffset

gbAtX	back to summary
private short[] gbAtX

gbAtY	back to summary
private short[] gbAtY

grayMax	back to summary
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

hdpHeight	back to summary
private short hdpHeight Height of the patterns in the pattern dictionary, 7.4.4.1.3

hdpWidth	back to summary
private short hdpWidth Width of the patterns in the pattern dictionary, 7.4.4.1.2

hdTemplate	back to summary
private byte hdTemplate

isMMREncoded	back to summary
private boolean isMMREncoded Pattern dictionary flags, 7.4.4.1.1

patterns	back to summary
private ArrayList<Bitmap> patterns Decoded bitmaps, stored to be used by segments, that refer to it

subInputStream	back to summary
private SubInputStream subInputStream

Constructor Detail

PatternDictionary	back to summary
public PatternDictionary()

Method Detail

checkInput	back to summary
private void checkInput() throws InvalidHeaderValueException

computeSegmentDataStructure	back to summary
private void computeSegmentDataStructure() throws IOException

extractPatterns	back to summary
private void extractPatterns(Bitmap collectiveBitmap)

getDictionary back to summary

getDictionary	back to summary
public ArrayList<Bitmap> getDictionary() throws IOException, InvalidHeaderValueException Implements org.apache.pdfbox.jbig2.Dictionary.getDictionary. This method decodes a pattern dictionary segment and returns an array of `Bitmap` s. Each of this `Bitmap`s is a pattern. The procedure is described in 6.7.5 (page 43). Returns:ArrayList<Bitmap> An array of `Bitmap`s as result of the decoding procedure. Exceptions IOException: Doc from org.apache.pdfbox.jbig2.Dictionary.getDictionary. if an underlying IO operation fails InvalidHeaderValueException: Doc from org.apache.pdfbox.jbig2.Dictionary.getDictionary. if the segment header value is invalid

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

Implements org.apache.pdfbox.jbig2.Dictionary.getDictionary.

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

Returns:ArrayList<Bitmap>

An array of Bitmaps as result of the decoding procedure.

Exceptions

IOException:

Doc from org.apache.pdfbox.jbig2.Dictionary.getDictionary.

if an underlying IO operation fails

InvalidHeaderValueException:

Doc from org.apache.pdfbox.jbig2.Dictionary.getDictionary.

if the segment header value is invalid

getGrayMax	back to summary
protected int getGrayMax()

getHdpHeight	back to summary
protected short getHdpHeight()

getHdpWidth	back to summary
protected short getHdpWidth()

getHdTemplate	back to summary
protected byte getHdTemplate()

init back to summary

init	back to summary
public void init(SegmentHeader header, SubInputStream sis) throws InvalidHeaderValueException, IOException Implements org.apache.pdfbox.jbig2.SegmentData.init. Doc from org.apache.pdfbox.jbig2.SegmentData.init. Parse the stream and read information of header. Parameters header:SegmentHeader - The segments' header (to make referred-to segments available in data part). sis:SubInputStream - Wrapped `ImageInputStream` into `SubInputStream`. Exceptions InvalidHeaderValueException: if the segment header value is invalid IOException: if an underlying IO operation fails

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

Implements org.apache.pdfbox.jbig2.SegmentData.init.

Doc from org.apache.pdfbox.jbig2.SegmentData.init.

Parse the stream and read information of header.

Parameters

header:SegmentHeader: - The segments' header (to make referred-to segments available in data part).
sis:SubInputStream: - Wrapped ImageInputStream into SubInputStream.