org.apache.pdfbox.text

Class PDFTextStripperByArea

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.PDFTextStripper

org.apache.pdfbox.text.PDFTextStripperByArea

public class PDFTextStripperByArea
extends PDFTextStripper

This will extract text from a specified region in the PDF.

Author:

Ben Litchfield

Field Summary

Fields inherited from class org.apache.pdfbox.text.PDFTextStripper

charactersByArticle, document, LINE_SEPARATOR, output

Constructor Summary

Constructors

Constructor and Description
PDFTextStripperByArea() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addRegion(String regionName, Rectangle2D rect) Add a new region to group text by.
protected float	computeFontHeight(PDFont font) Compute the font height.
void	extractRegions(PDPage page) Process the page to extract the region text.
List<String>	getRegions() Get the list of regions that have been setup.
String	getTextForRegion(String regionName) Get the text for the region, this should be called after extractRegions().
protected void	processTextPosition(TextPosition text) This will process a TextPosition object and add the text to the list of characters on a page.
void	removeRegion(String regionName) Delete a region to group text by.
void	setShouldSeparateByBeads(boolean aShouldSeparateByBeads) This method does nothing in this derived class, because beads and regions are incompatible.
protected void	showGlyph(Matrix textRenderingMatrix, PDFont font, int code, Vector displacement) Called when a glyph is to be processed.
protected void	writePage() This will print the processed page text to the output stream.

Methods inherited from class org.apache.pdfbox.text.PDFTextStripper

beginMarkedContentSequence, endArticle, endDocument, endMarkedContentSequence, endPage, getAddMoreFormatting, getArticleEnd, getArticleStart, getAverageCharTolerance, getCharactersByArticle, getCurrentPageNo, getDropThreshold, getEndBookmark, getEndPage, getIgnoreContentStreamSpaceGlyphs, getIndentThreshold, getLineSeparator, getListItemPatterns, getOutput, getPageEnd, getPageStart, getParagraphEnd, getParagraphStart, getSeparateByBeads, getSortByPosition, getSpacingTolerance, getStartBookmark, getStartPage, getSuppressDuplicateOverlappingText, getText, getWordSeparator, matchPattern, processPage, processPages, setAddMoreFormatting, setArticleEnd, setArticleStart, setAverageCharTolerance, setDropThreshold, setEndBookmark, setEndPage, setIgnoreContentStreamSpaceGlyphs, setIndentThreshold, setLineSeparator, setListItemPatterns, setPageEnd, setPageStart, setParagraphEnd, setParagraphStart, setSortByPosition, setSpacingTolerance, setStartBookmark, setStartPage, setSuppressDuplicateOverlappingText, setWordSeparator, startArticle, startArticle, startDocument, startPage, writeCharacters, writeLineSeparator, writePageEnd, writePageStart, writeParagraphEnd, writeParagraphSeparator, writeParagraphStart, writeString, writeString, writeText, writeWordSeparator

Methods inherited from class org.apache.pdfbox.contentstream.PDFStreamEngine

addOperator, applyTextAdjustment, beginText, decreaseLevel, endText, getAppearance, getCurrentPage, getGraphicsStackSize, getGraphicsState, getInitialMatrix, getLevel, getResources, getTextLineMatrix, getTextMatrix, increaseLevel, isShouldProcessColorOperators, markedContentPoint, operatorException, processAnnotation, processChildStream, processOperator, processOperator, processSoftMask, processTilingPattern, processTilingPattern, processTransparencyGroup, processType3Stream, restoreGraphicsStack, restoreGraphicsState, saveGraphicsStack, saveGraphicsState, setLineDashPattern, setTextLineMatrix, setTextMatrix, showAnnotation, showFontGlyph, showForm, showText, showTextString, showTextStrings, showTransparencyGroup, showType3Glyph, transformedPoint, transformWidth, unsupportedOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFTextStripperByArea

public PDFTextStripperByArea()
                      throws IOException

Constructor.

Throws:

IOException - If there is an error loading properties.

Method Detail

setShouldSeparateByBeads

public final void setShouldSeparateByBeads(boolean aShouldSeparateByBeads)

This method does nothing in this derived class, because beads and regions are incompatible. Beads are ignored when stripping by area.

Overrides:

setShouldSeparateByBeads in class PDFTextStripper

Parameters:

aShouldSeparateByBeads - The new grouping of beads.

addRegion

public void addRegion(String regionName,
                      Rectangle2D rect)

Add a new region to group text by.

Parameters:

regionName - The name of the region.

rect - The rectangle area to retrieve the text from. The y-coordinates are java coordinates (y == 0 is top), not PDF coordinates (y == 0 is bottom).

removeRegion

public void removeRegion(String regionName)

Delete a region to group text by. If the region does not exist, this method does nothing.

Parameters:

regionName - The name of the region to delete.

getRegions

public List<String> getRegions()

Get the list of regions that have been setup.

Returns:

A list of java.lang.String objects to identify the region names.

getTextForRegion

public String getTextForRegion(String regionName)

Get the text for the region, this should be called after extractRegions().

Parameters:

regionName - The name of the region to get the text from.

Returns:

The text that was identified in that region.

extractRegions

public void extractRegions(PDPage page)
                    throws IOException

Process the page to extract the region text.

Parameters:

page - The page to extract the regions from.

Throws:

IOException - If there is an error while extracting text.

processTextPosition

protected void processTextPosition(TextPosition text)

This will process a TextPosition object and add the text to the list of characters on a page. It takes care of overlapping text.

Overrides:

processTextPosition in class PDFTextStripper

Parameters:

text - The text to process.

writePage

protected void writePage()
                  throws IOException

This will print the processed page text to the output stream.

Overrides:

writePage in class PDFTextStripper

Throws:

IOException - If there is an error writing the text.

showGlyph

protected void showGlyph(Matrix textRenderingMatrix,
                         PDFont font,
                         int code,
                         Vector displacement)
                  throws IOException

Called when a glyph is to be processed. The heuristic calculations here were originally written by Ben Litchfield for PDFStreamEngine.

Overrides:

showGlyph in class PDFStreamEngine

Parameters:

textRenderingMatrix - the current text rendering matrix, T_rm

font - the current font

code - internal PDF character code for the glyph

displacement - the displacement (i.e. advance) of the glyph in text space

Throws:

IOException - if the glyph cannot be processed

computeFontHeight

protected float computeFontHeight(PDFont font)
                           throws IOException

Compute the font height. Override this if you want to use own calculations.

Parameters:

font - the font.

Returns:

the font height.

Throws:

IOException - if there is an error while getting the font bounding box.