com.tsgrp.opencontent.universal.util

Class RegexTextStripper

java.lang.Object

org.apache.pdfbox.util.PDFStreamEngine

org.apache.pdfbox.util.PDFTextStripper

com.tsgrp.opencontent.universal.util.RegexTextStripper

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

A Customization of PDFTextStripper which searches a document and finds locations where the user may want data redacted.

Field Summary

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

charactersByArticle, document, output, outputEncoding, systemLineSeparator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearSuggestedRedactionsMap() Clears out our map of suggested Redactions.
java.util.Map<java.lang.String,java.lang.String>	getRedactionRegexAttrMap() Returns the map of things to be redacted and their corresponding regex pattern.
java.util.Map<java.lang.String,java.util.List<RedactionSuggestion>>	getSuggestedRedactionsMap() Returns the map of possible redaction strings to suggested redaction objects.
void	setRedactionRegexAttrMap(java.util.Map<java.lang.String,java.lang.String> redactionRegexAttrMap) Sets the map of things to be redacted and their corresponding regex pattern.
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

RegexTextStripper

public RegexTextStripper()
                  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

getRedactionRegexAttrMap

public java.util.Map<java.lang.String,java.lang.String> getRedactionRegexAttrMap()

Returns the map of things to be redacted and their corresponding regex pattern.

Returns:

Our map containing the regex patterns.

setRedactionRegexAttrMap

public void setRedactionRegexAttrMap(java.util.Map<java.lang.String,java.lang.String> redactionRegexAttrMap)

Sets the map of things to be redacted and their corresponding regex pattern.

getSuggestedRedactionsMap

public java.util.Map<java.lang.String,java.util.List<RedactionSuggestion>> getSuggestedRedactionsMap()

Returns the map of possible redaction strings to suggested redaction objects.

Returns:

Our map of RedactionSuggestion objects.

clearSuggestedRedactionsMap

public void clearSuggestedRedactionsMap()

Clears out our map of suggested Redactions.

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. This method retrieves regex patterns that match strings that are likely to be redacted, then parses through the text and creates a RedactionSuggestion object for each match. We assume no regex will span more than a single line of text and that there will be at most 1 match per regex in any given line.

Overrides:

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

Throws:

java.io.IOException