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

Field Summary

Modifier and Type	Field and Description
private long	amountOfSymbolInstances Number of symbol instances, 7.4.3.1.4
private int	amountOfSymbols
private ArithmeticDecoder	arithmeticDecoder
private CombinationOperator	combinationOperator
private long	currentS Further parameters
private CX	cx
private CX	cxIADS
private CX	cxIADT
private CX	cxIAFS
private CX	cxIAID
private CX	cxIAIT
private CX	cxIARDH
private CX	cxIARDW
private CX	cxIARDX
private CX	cxIARDY
private CX	cxIARI
private short	defaultPixel
private HuffmanTable	dsTable
private HuffmanTable	fsTable User-supplied tables *
private GenericRefinementRegion	genericRefinementRegion
private ArithmeticIntegerDecoder	integerDecoder
private boolean	isHuffmanEncoded
private short	isTransposed
private short	logSBStrips
private HuffmanTable	rdhTable
private HuffmanTable	rdwTable
private HuffmanTable	rdxTable
private HuffmanTable	rdyTable
private short	referenceCorner
private Bitmap	regionBitmap
private RegionSegmentInformation	regionInfo Region segment information field, 7.4.1
private HuffmanTable	rSizeTable
private short	sbdsOffset
private short	sbHuffDS
private short	sbHuffDT
private short	sbHuffFS
private short	sbHuffRDHeight
private short	sbHuffRDWidth
private short	sbHuffRDX
private short	sbHuffRDY
private short	sbHuffRSize Text region segment Huffman flags, 7.4.3.1.2
private short[]	sbrATX Text region refinement AT flags, 7.4.3.1.3
private short[]	sbrATY
private short	sbrTemplate Text region segment flags, 7.4.3.1.1
private int	sbStrips
private SegmentHeader	segmentHeader
private SubInputStream	subInputStream
private int	symbolCodeLength codeTable including a code to each symbol used in that region
private FixedSizeTable	symbolCodeTable
private ArrayList<Bitmap>	symbols
private HuffmanTable	table
private boolean	useRefinement

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
private final void	blit(Bitmap ib, long t)
private void	checkInput()
private void	computeSymbolCodeLength()
private void	createRegionBitmap()
private final long	decodeCurrentT()
private final long	decodeDfS()
private final long	decodeDT()
private final Bitmap	decodeIb(long r, long id)
private final long	decodeID()
private final long	decodeIdS()
private final long	decodeRdh()
private final long	decodeRdw()
private final long	decodeRdx()
private final long	decodeRdy()
private final long	decodeRI()
private final long	decodeStripT()
private void	decodeSymbolInstances()
private final long	decodeSymInRefSize()
public Bitmap	getRegionBitmap() Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap. Decodes and returns a regions content.
public RegionSegmentInformation	getRegionInfo() Implements org.apache.pdfbox.jbig2.Region.getRegionInfo. Simply returns the `RegionSegmentInformation`.
private void	getSymbols()
private HuffmanTable	getUserTable(final int tablePosition)
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.
private void	initSymbols()
private void	parseHeader()
private void	readAmountOfSymbolInstances()
private void	readHuffmanFlags()
private void	readRegionFlags()
private void	readUseRefinement()
private void	setCodingStatistics()
protected void	setContexts(CX cx, CX cxIADT, CX cxIAFS, CX cxIADS, CX cxIAIT, CX cxIAID, CX cxIARDW, CX cxIARDH, CX cxIARDX, CX cxIARDY)
protected void	setParameters(ArithmeticDecoder arithmeticDecoder, ArithmeticIntegerDecoder iDecoder, boolean isHuffmanEncoded, boolean sbRefine, int sbw, int sbh, long sbNumInstances, int sbStrips, int sbNumSyms, short sbDefaultPixel, short sbCombinationOperator, short transposed, short refCorner, short sbdsOffset, short sbHuffFS, short sbHuffDS, short sbHuffDT, short sbHuffRDWidth, short sbHuffRDHeight, short sbHuffRDX, short sbHuffRDY, short sbHuffRSize, short sbrTemplate, short[] sbrATX, short[] sbrATY, ArrayList<Bitmap> sbSyms, int sbSymCodeLen)
private void	symbolIDCodeLengths()

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

Field Detail

amountOfSymbolInstances	back to summary
private long amountOfSymbolInstances Number of symbol instances, 7.4.3.1.4

amountOfSymbols	back to summary
private int amountOfSymbols

arithmeticDecoder	back to summary
private ArithmeticDecoder arithmeticDecoder

combinationOperator	back to summary
private CombinationOperator combinationOperator

currentS	back to summary
private long currentS Further parameters

cx	back to summary
private CX cx

cxIADS	back to summary
private CX cxIADS

cxIADT	back to summary
private CX cxIADT

cxIAFS	back to summary
private CX cxIAFS

cxIAID	back to summary
private CX cxIAID

cxIAIT	back to summary
private CX cxIAIT

cxIARDH	back to summary
private CX cxIARDH

cxIARDW	back to summary
private CX cxIARDW

cxIARDX	back to summary
private CX cxIARDX

cxIARDY	back to summary
private CX cxIARDY

cxIARI	back to summary
private CX cxIARI

defaultPixel	back to summary
private short defaultPixel

dsTable	back to summary
private HuffmanTable dsTable

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

genericRefinementRegion	back to summary
private GenericRefinementRegion genericRefinementRegion

integerDecoder	back to summary
private ArithmeticIntegerDecoder integerDecoder

isHuffmanEncoded	back to summary
private boolean isHuffmanEncoded

isTransposed	back to summary
private short isTransposed

logSBStrips	back to summary
private short logSBStrips

rdhTable	back to summary
private HuffmanTable rdhTable

rdwTable	back to summary
private HuffmanTable rdwTable

rdxTable	back to summary
private HuffmanTable rdxTable

rdyTable	back to summary
private HuffmanTable rdyTable

referenceCorner	back to summary
private short referenceCorner

regionBitmap	back to summary
private Bitmap regionBitmap

regionInfo	back to summary
private RegionSegmentInformation regionInfo Region segment information field, 7.4.1

rSizeTable	back to summary
private HuffmanTable rSizeTable

sbdsOffset	back to summary
private short sbdsOffset

sbHuffDS	back to summary
private short sbHuffDS

sbHuffDT	back to summary
private short sbHuffDT

sbHuffFS	back to summary
private short sbHuffFS

sbHuffRDHeight	back to summary
private short sbHuffRDHeight

sbHuffRDWidth	back to summary
private short sbHuffRDWidth

sbHuffRDX	back to summary
private short sbHuffRDX

sbHuffRDY	back to summary
private short sbHuffRDY

sbHuffRSize	back to summary
private short sbHuffRSize Text region segment Huffman flags, 7.4.3.1.2

sbrATX	back to summary
private short[] sbrATX Text region refinement AT flags, 7.4.3.1.3

sbrATY	back to summary
private short[] sbrATY

sbrTemplate	back to summary
private short sbrTemplate Text region segment flags, 7.4.3.1.1

sbStrips	back to summary
private int sbStrips

segmentHeader	back to summary
private SegmentHeader segmentHeader

subInputStream	back to summary
private SubInputStream subInputStream

symbolCodeLength	back to summary
private int symbolCodeLength codeTable including a code to each symbol used in that region

symbolCodeTable	back to summary
private FixedSizeTable symbolCodeTable

symbols	back to summary
private ArrayList<Bitmap> symbols

table	back to summary
private HuffmanTable table

useRefinement	back to summary
private boolean useRefinement

Constructor Detail

TextRegion	back to summary
public TextRegion()

TextRegion	back to summary
public TextRegion(SubInputStream subInputStream, SegmentHeader segmentHeader)

Method Detail

blit	back to summary
private final void blit(Bitmap ib, long t)

checkInput	back to summary
private void checkInput() throws InvalidHeaderValueException

computeSymbolCodeLength	back to summary
private void computeSymbolCodeLength() throws IOException

createRegionBitmap	back to summary
private void createRegionBitmap()

decodeCurrentT	back to summary
private final long decodeCurrentT() throws IOException

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

decodeDT	back to summary
private final long decodeDT() throws IOException

decodeIb	back to summary
private final Bitmap decodeIb(long r, long id) throws IOException, InvalidHeaderValueException, IntegerMaxValueException

decodeID	back to summary
private final long decodeID() throws IOException

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

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

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

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

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

decodeRI	back to summary
private final long decodeRI() throws IOException

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

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

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

getRegionBitmap back to summary

public Bitmap getRegionBitmap() throws IOException, IntegerMaxValueException, InvalidHeaderValueException

Implements org.apache.pdfbox.jbig2.Region.getRegionBitmap.

Doc from org.apache.pdfbox.jbig2.Region.getRegionBitmap.

Decodes and returns a regions content.

Returns:Bitmap

The decoded region as Bitmap.

Exceptions

IOException:: if an underlying IO operation fails
IntegerMaxValueException:: if the maximum value limit of an integer is exceeded
InvalidHeaderValueException:: if the segment header value is invalid

getRegionInfo back to summary

public RegionSegmentInformation getRegionInfo()

Implements org.apache.pdfbox.jbig2.Region.getRegionInfo.

Doc from org.apache.pdfbox.jbig2.Region.getRegionInfo.

Simply returns the RegionSegmentInformation.

Returns:RegionSegmentInformation: The RegionSegmentInformation.

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

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

init back to summary

public void init(SegmentHeader header, 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

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

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

readAmountOfSymbolInstances	back to summary
private void readAmountOfSymbolInstances() throws IOException

readHuffmanFlags	back to summary
private void readHuffmanFlags() throws IOException

readRegionFlags	back to summary
private void readRegionFlags() throws IOException

readUseRefinement	back to summary
private void readUseRefinement() throws IOException

setCodingStatistics	back to summary
private void setCodingStatistics() throws IOException

setContexts	back to summary
protected void setContexts(CX cx, CX cxIADT, CX cxIAFS, CX cxIADS, CX cxIAIT, CX cxIAID, CX cxIARDW, CX cxIARDH, CX cxIARDX, CX cxIARDY)

setParameters

back to summary

protected void setParameters(ArithmeticDecoder arithmeticDecoder, ArithmeticIntegerDecoder iDecoder, boolean isHuffmanEncoded, boolean sbRefine, int sbw, int sbh, long sbNumInstances, int sbStrips, int sbNumSyms, short sbDefaultPixel, short sbCombinationOperator, short transposed, short refCorner, short sbdsOffset, short sbHuffFS, short sbHuffDS, short sbHuffDT, short sbHuffRDWidth, short sbHuffRDHeight, short sbHuffRDX, short sbHuffRDY, short sbHuffRSize, short sbrTemplate, short[] sbrATX, short[] sbrATY, ArrayList<Bitmap> sbSyms, int sbSymCodeLen)

symbolIDCodeLengths	back to summary
private void symbolIDCodeLengths() throws IOException

public Class TextRegion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail