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

Field Summary

Modifier and Type	Field and Description
private HuffmanTable	aggInstTable
private int	amountOfDecodedSymbols
private int	amountOfExportSymbolss Number of exported symbols, 7.4.2.1.4
private int	amountOfImportedSymbolss
private int	amountOfNewSymbols Number of new symbols, 7.4.2.1.5
private ArithmeticDecoder	arithmeticDecoder
private HuffmanTable	bmSizeTable
private CX	cx
private CX	cxIAAI
private CX	cxIADH
private CX	cxIADT
private CX	cxIADW
private CX	cxIAEX
protected CX	cxIAID
private CX	cxIARDX
private CX	cxIARDY
private HuffmanTable	dhTable User-supplied tables *
private HuffmanTable	dwTable
private ArrayList<Bitmap>	exportSymbols Return value of that segment
private GenericRefinementRegion	genericRefinementRegion
private GenericRegion	genericRegion
private ArithmeticIntegerDecoder	iDecoder
private ArrayList<Bitmap>	importSymbols
private boolean	isCodingContextRetained
private boolean	isCodingContextUsed
private boolean	isHuffmanEncoded
private Bitmap[]	newSymbols
private ArrayList<Bitmap>	sbSymbols
private int	sbSymCodeLen
private short[]	sdATX Symbol dictionary AT flags, 7.4.2.1.2
private short[]	sdATY
private short	sdHuffAggInstanceSelection
private short	sdHuffBMSizeSelection
private short	sdHuffDecodeHeightSelection
private short	sdHuffDecodeWidthSelection
private short[]	sdrATX Symbol dictionary refinement AT flags, 7.4.2.1.3
private short[]	sdrATY
private short	sdrTemplate Symbol dictionary flags, 7.4.2.1.1
private byte	sdTemplate
private SegmentHeader	segmentHeader Further parameters
private SubInputStream	subInputStream
private TextRegion	textRegion
private boolean	useRefinementAggregation

Constructor Summary

Access	Constructor and Description
public	SymbolDictionary()
public	SymbolDictionary(final SubInputStream subInputStream, final SegmentHeader segmentHeader)

Method Summary

Modifier and Type	Method and Description
private final void	addSymbol(final Region region)
private void	checkInput()
private final void	decodeAggregate(final int symbolWidth, final int heightClassHeight)
private final long	decodeDifferenceWidth()
private final void	decodeDirectlyThroughGenericRegion(final int symWidth, final int hcHeight)
private final void	decodeHeightClassBitmap(final Bitmap heightClassCollectiveBitmap, final int heightClassFirstSymbol, final int heightClassHeight, final int[] newSymbolsWidths)
private final Bitmap	decodeHeightClassCollectiveBitmap(final long bmSize, final int heightClassHeight, final int totalWidth)
private final long	decodeHeightClassDeltaHeight()
private final long	Returns: long - Result of decoding HCDH decodeHeightClassDeltaHeightWithHuffman() 6.5.6 if isHuffmanEncoded
private final void	decodeNewSymbols(final int symWidth, final int hcHeight, final Bitmap ibo, final int rdx, final int rdy)
private final void	decodeRefinedSymbol(final int symbolWidth, final int heightClassHeight)
private final void	decodeThroughTextRegion(final int symbolWidth, final int heightClassHeight, final long amountOfRefinementAggregationInstances)
public ArrayList<Bitmap>	Returns: List of decoded symbol bitmaps as an `ArrayList` getDictionary() Implements org.apache.pdfbox.jbig2.Dictionary.getDictionary. 6.5.5 Decoding the symbol dictionary
private int	Returns: Result of computing SBSYMCODELEN getSbSymCodeLen() 6.5.8.2.3 - Setting SBSYMCODES and SBSYMCODELEN
private int[]	getToExportFlags()
private HuffmanTable	getUserTable(final int tablePosition)
private final long	huffDecodeBmSize()
private final long	huffDecodeRefAggNInst()
public void	init(final SegmentHeader - The segments' header (to make referred-to segments available in data part). header, final SubInputStream - Wrapped `ImageInputStream` into `SubInputStream`. sis) Implements org.apache.pdfbox.jbig2.SegmentData.init. Parse the stream and read information of header.
private void	parseHeader()
private void	readAmountOfExportedSymbols()
private void	readAmountOfNewSymbols()
private void	readAtPixels(final int amountOfPixels)
private void	readRefinementAtPixels(final int amountOfAtPixels)
private void	readRegionFlags()
private void	retrieveImportSymbols() Concatenates symbols from all referred-to segments.
private void	setAtPixels()
private void	setCodingStatistics()
private void	setExportedSymbols(final int[] toExportFlags)
private void	setInSyms()
private void	setRefinementAtPixels()
private void	setRetainedCodingContexts(final SymbolDictionary sd)
private final void	setSymbolsArray() 6.5.8.2.4 - Setting SBSYMS

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

Field Detail

aggInstTable	back to summary
private HuffmanTable aggInstTable

amountOfDecodedSymbols	back to summary
private int amountOfDecodedSymbols

amountOfExportSymbolss	back to summary
private int amountOfExportSymbolss Number of exported symbols, 7.4.2.1.4

amountOfImportedSymbolss	back to summary
private int amountOfImportedSymbolss

amountOfNewSymbols	back to summary
private int amountOfNewSymbols Number of new symbols, 7.4.2.1.5

arithmeticDecoder	back to summary
private ArithmeticDecoder arithmeticDecoder

bmSizeTable	back to summary
private HuffmanTable bmSizeTable

cx	back to summary
private CX cx

cxIAAI	back to summary
private CX cxIAAI

cxIADH	back to summary
private CX cxIADH

cxIADT	back to summary
private CX cxIADT

cxIADW	back to summary
private CX cxIADW

cxIAEX	back to summary
private CX cxIAEX

cxIAID	back to summary
protected CX cxIAID

cxIARDX	back to summary
private CX cxIARDX

cxIARDY	back to summary
private CX cxIARDY

dhTable	back to summary
private HuffmanTable dhTable User-supplied tables *

dwTable	back to summary
private HuffmanTable dwTable

exportSymbols	back to summary
private ArrayList<Bitmap> exportSymbols Return value of that segment

genericRefinementRegion	back to summary
private GenericRefinementRegion genericRefinementRegion

genericRegion	back to summary
private GenericRegion genericRegion

iDecoder	back to summary
private ArithmeticIntegerDecoder iDecoder

importSymbols	back to summary
private ArrayList<Bitmap> importSymbols

isCodingContextRetained	back to summary
private boolean isCodingContextRetained

isCodingContextUsed	back to summary
private boolean isCodingContextUsed

isHuffmanEncoded	back to summary
private boolean isHuffmanEncoded

newSymbols	back to summary
private Bitmap[] newSymbols

sbSymbols	back to summary
private ArrayList<Bitmap> sbSymbols

sbSymCodeLen	back to summary
private int sbSymCodeLen

sdATX	back to summary
private short[] sdATX Symbol dictionary AT flags, 7.4.2.1.2

sdATY	back to summary
private short[] sdATY

sdHuffAggInstanceSelection	back to summary
private short sdHuffAggInstanceSelection

sdHuffBMSizeSelection	back to summary
private short sdHuffBMSizeSelection

sdHuffDecodeHeightSelection	back to summary
private short sdHuffDecodeHeightSelection

sdHuffDecodeWidthSelection	back to summary
private short sdHuffDecodeWidthSelection

sdrATX	back to summary
private short[] sdrATX Symbol dictionary refinement AT flags, 7.4.2.1.3

sdrATY	back to summary
private short[] sdrATY

sdrTemplate	back to summary
private short sdrTemplate Symbol dictionary flags, 7.4.2.1.1

sdTemplate	back to summary
private byte sdTemplate

segmentHeader	back to summary
private SegmentHeader segmentHeader Further parameters

subInputStream	back to summary
private SubInputStream subInputStream

textRegion	back to summary
private TextRegion textRegion

useRefinementAggregation	back to summary
private boolean useRefinementAggregation

Constructor Detail

SymbolDictionary	back to summary
public SymbolDictionary()

SymbolDictionary	back to summary
public SymbolDictionary(final SubInputStream subInputStream, final SegmentHeader segmentHeader) throws IOException

Method Detail

addSymbol	back to summary
private final void addSymbol(final Region region) throws IntegerMaxValueException, InvalidHeaderValueException, IOException

checkInput	back to summary
private void checkInput() throws InvalidHeaderValueException

decodeAggregate	back to summary
private final void decodeAggregate(final int symbolWidth, final int heightClassHeight) throws IOException, InvalidHeaderValueException, IntegerMaxValueException

decodeDifferenceWidth	back to summary
private final long decodeDifferenceWidth() throws IOException, InvalidHeaderValueException

decodeDirectlyThroughGenericRegion	back to summary
private final void decodeDirectlyThroughGenericRegion(final int symWidth, final int hcHeight) throws IOException, IntegerMaxValueException, InvalidHeaderValueException

decodeHeightClassBitmap	back to summary
private final void decodeHeightClassBitmap(final Bitmap heightClassCollectiveBitmap, final int heightClassFirstSymbol, final int heightClassHeight, final int[] newSymbolsWidths) throws IntegerMaxValueException, InvalidHeaderValueException, IOException

decodeHeightClassCollectiveBitmap	back to summary
private final Bitmap decodeHeightClassCollectiveBitmap(final long bmSize, final int heightClassHeight, final int totalWidth) throws IOException

decodeHeightClassDeltaHeight	back to summary
private final long decodeHeightClassDeltaHeight() throws IOException, InvalidHeaderValueException

decodeHeightClassDeltaHeightWithHuffman

back to summary

private final long decodeHeightClassDeltaHeightWithHuffman() throws IOException, InvalidHeaderValueException

6.5.6 if isHuffmanEncoded

Returns:long: long - Result of decoding HCDH

decodeNewSymbols	back to summary
private final void decodeNewSymbols(final int symWidth, final int hcHeight, final Bitmap ibo, final int rdx, final int rdy) throws IOException, InvalidHeaderValueException, IntegerMaxValueException

decodeRefinedSymbol	back to summary
private final void decodeRefinedSymbol(final int symbolWidth, final int heightClassHeight) throws IOException, InvalidHeaderValueException, IntegerMaxValueException

decodeThroughTextRegion	back to summary
private final void decodeThroughTextRegion(final int symbolWidth, final int heightClassHeight, final long amountOfRefinementAggregationInstances) throws IOException, IntegerMaxValueException, InvalidHeaderValueException

getDictionary back to summary

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

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

6.5.5 Decoding the symbol dictionary

Returns:ArrayList<Bitmap>

List of decoded symbol bitmaps as an ArrayList

Exceptions

IOException:

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

if an underlying IO operation fails

IntegerMaxValueException:

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

if the maximum value limit of an integer is exceeded

InvalidHeaderValueException:

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

if the segment header value is invalid

getSbSymCodeLen

back to summary

private int getSbSymCodeLen() throws IOException

6.5.8.2.3 - Setting SBSYMCODES and SBSYMCODELEN

Returns:int: Result of computing SBSYMCODELEN

getToExportFlags	back to summary
private int[] getToExportFlags() throws IOException, InvalidHeaderValueException

getUserTable	back to summary
private HuffmanTable getUserTable(final int tablePosition) throws InvalidHeaderValueException, IOException

huffDecodeBmSize	back to summary
private final long huffDecodeBmSize() throws IOException, InvalidHeaderValueException

huffDecodeRefAggNInst	back to summary
private final long huffDecodeRefAggNInst() throws IOException, InvalidHeaderValueException

init back to summary

public void init(final SegmentHeader header, final SubInputStream sis) throws InvalidHeaderValueException, IntegerMaxValueException, 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
IntegerMaxValueException:: if the maximum value limit of an integer is exceeded
IOException:: if an underlying IO operation fails

parseHeader	back to summary
private void parseHeader() throws IOException, InvalidHeaderValueException, IntegerMaxValueException

readAmountOfExportedSymbols	back to summary
private void readAmountOfExportedSymbols() throws IOException

readAmountOfNewSymbols	back to summary
private void readAmountOfNewSymbols() throws IOException

readAtPixels	back to summary
private void readAtPixels(final int amountOfPixels) throws IOException

readRefinementAtPixels	back to summary
private void readRefinementAtPixels(final int amountOfAtPixels) throws IOException

readRegionFlags	back to summary
private void readRegionFlags() throws IOException

retrieveImportSymbols	back to summary
private void retrieveImportSymbols() throws IOException, InvalidHeaderValueException, IntegerMaxValueException Concatenates symbols from all referred-to segments.

setAtPixels	back to summary
private void setAtPixels() throws IOException

setCodingStatistics	back to summary
private void setCodingStatistics() throws IOException

setExportedSymbols	back to summary
private void setExportedSymbols(final int[] toExportFlags)

setInSyms	back to summary
private void setInSyms() throws IOException, InvalidHeaderValueException, IntegerMaxValueException

setRefinementAtPixels	back to summary
private void setRefinementAtPixels() throws IOException

setRetainedCodingContexts	back to summary
private void setRetainedCodingContexts(final SymbolDictionary sd)

setSymbolsArray	back to summary
private final void setSymbolsArray() throws IOException, InvalidHeaderValueException, IntegerMaxValueException 6.5.8.2.4 - Setting SBSYMS

public Class SymbolDictionary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail