com.tsgrp.opencontent.universal.util

Class TSGTextStripper

java.lang.Object

org.apache.pdfbox.util.PDFStreamEngine

org.apache.pdfbox.util.PDFTextStripper

com.tsgrp.opencontent.universal.util.TSGTextStripper

public class TSGTextStripper
extends org.apache.pdfbox.util.PDFTextStripper

A Customization of PDFTextStripper which also builds up an index for words within the PDF. That index contains their position.

Field Summary

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

charactersByArticle, document, output, outputEncoding, systemLineSeparator

Constructor Summary

Constructors

Constructor and Description
TSGTextStripper() Initialize our hash map, in addition to the parent constructor.

Method Summary

Modifier and Type	Method and Description
IndexRectangle	buildIndexRect(org.apache.pdfbox.util.TextPosition firstTextPosition, org.apache.pdfbox.util.TextPosition lastTextPosition)
boolean	checkForLinkStart(java.lang.String textPositionsWord) Checks if the given string is the beginning of a link
void	clearTextLinks() Clears out all the detected internal links found.
void	clearWordMap() Clear all the index entries out of the map.
java.lang.String	getStringFromTextPosition(org.apache.pdfbox.util.TextPosition textPosition) Method to return the String at a given TextPosition.
java.util.List<TSGInternalLink>	getTextLinks() Returns links detected within the text of the document.
java.util.Map<java.lang.String,java.util.List<TSGIndexEntry>>	getWordsWithPositions() Returns the processed word-to-index map.
protected void	writeString(java.lang.String text, java.util.List<org.apache.pdfbox.util.TextPosition> textPositions) Called for each line of text stripped off of the PDF.

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

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

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

getColorSpaces, getCurrentPage, getFonts, getGraphicsStack, getGraphicsState, getGraphicsStates, getResources, getTextLineMatrix, getTextMatrix, getTotalCharCnt, getValidCharCnt, getXObjects, isForceParsing, processEncodedText, processOperator, processOperator, processStream, processSubStream, registerOperatorProcessor, setColorSpaces, setFonts, setForceParsing, setGraphicsStack, setGraphicsState, setGraphicsStates, setTextLineMatrix, setTextMatrix

Methods inherited from class java.lang.Object

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

Constructor Detail

TSGTextStripper

public TSGTextStripper()
                throws java.io.IOException

Initialize our hash map, in addition to the parent constructor.

Throws:

java.io.IOException - If there is an error loading the properties.

Method Detail

writeString

protected void writeString(java.lang.String text,
                           java.util.List<org.apache.pdfbox.util.TextPosition> textPositions)
                    throws java.io.IOException

Called for each line of text stripped off of the PDF. We build up our index here, and use the textPosition data to construct the rectangles that are included in those indexs. We also use this method to remove whitespace / punctuation from the words getting placed in the map.

Overrides:

writeString in class org.apache.pdfbox.util.PDFTextStripper

Throws:

java.io.IOException

buildIndexRect

public IndexRectangle buildIndexRect(org.apache.pdfbox.util.TextPosition firstTextPosition,
                                     org.apache.pdfbox.util.TextPosition lastTextPosition)

Parameters:

firstTextPosition - - The location of the start of the text

lastTextPosition - - The location of the start of the text

Returns:

the newly created IndexRectangle object

checkForLinkStart

public boolean checkForLinkStart(java.lang.String textPositionsWord)

Checks if the given string is the beginning of a link

Parameters:

textPositionsWord - - The text that we are checking

Returns:

True if the text appears to be the start of a link

getWordsWithPositions

public java.util.Map<java.lang.String,java.util.List<TSGIndexEntry>> getWordsWithPositions()

Returns the processed word-to-index map.

Returns:

Our map of TSGIndexEntry objects.

getTextLinks

public java.util.List<TSGInternalLink> getTextLinks()

Returns links detected within the text of the document.

Returns:

Our list of lists populated with TSGInternalLink objects.

clearTextLinks

public void clearTextLinks()

Clears out all the detected internal links found.

clearWordMap

public void clearWordMap()

Clear all the index entries out of the map.

getStringFromTextPosition

public java.lang.String getStringFromTextPosition(org.apache.pdfbox.util.TextPosition textPosition)

Method to return the String at a given TextPosition.

Parameters:

textPosition - the text position to get the text from

Returns:

a String of the text at the given text position