org.jpedal.grouping

Class PdfTextExtractionUtils

java.lang.Object

org.jpedal.grouping.PdfTextExtractionUtils

public class PdfTextExtractionUtils
extends Object

Applies heuristics to unstructured PDF text to create content

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PdfTextExtractionUtils.ResultsComparator
protected static class	PdfTextExtractionUtils.ResultsComparatorRectangle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfTextExtractionUtils(PdfData pdf_data, boolean isXMLExtraction) Create a new instance, passing in raw data

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	extractTextAsTable(int x1, int y1, int x2, int y2, int pageNumber, boolean isCSV, boolean keepFontInfo, boolean keepWidthInfo, boolean keepAlignmentInfo, int borderWidth) Calls various low level merging routines on merge -
protected List<String>	extractTextAsWordlist(int x1, int y1, int x2, int y2, int page_number, boolean breakFragments, String punctuation) Algorithm to place data from within coordinates to a vector of word, word coords (x1,y1,x2,y2)
protected String	extractTextInRectangle(int x1, int y1, int x2, int y2, int page_number, boolean estimateParagraphs, boolean breakFragments) Algorithm to place data from specified coordinates on a page into a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfTextExtractionUtils

protected PdfTextExtractionUtils(PdfData pdf_data,
                                 boolean isXMLExtraction)

Create a new instance, passing in raw data

Parameters:

pdf_data - PdfData from the pdf to search

isXMLExtraction - Boolean flag to specify if output should be xml

Method Detail

extractTextAsTable

protected final Map<String,String> extractTextAsTable(int x1,
                                                      int y1,
                                                      int x2,
                                                      int y2,
                                                      int pageNumber,
                                                      boolean isCSV,
                                                      boolean keepFontInfo,
                                                      boolean keepWidthInfo,
                                                      boolean keepAlignmentInfo,
                                                      int borderWidth)
                                               throws PdfException

Calls various low level merging routines on merge -

isCSV sets if output is XHTML or CSV format -

XHTML also has options to include font tags (keepFontInfo), preserve widths (keepWidthInfo), try to preserve alignment (keepAlignmentInfo), and set a table border width (borderWidth) - AddCustomTags should always be set to false

Parameters:

x1 - is the x coord of the top left corner

y1 - is the y coord of the top left corner

x2 - is the x coord of the bottom right corner

y2 - is the y coord of the bottom right corner

pageNumber - is the page you wish to extract from

isCSV - is a boolean. If false the output is xhtml if true the text is out as CSV

keepFontInfo - if true and isCSV is false keeps font information in extrated text.

keepWidthInfo - if true and isCSV is false keeps width information in extrated text.

keepAlignmentInfo - if true and isCSV is false keeps alignment information in extrated text.

borderWidth - is the width of the border for xhtml

Returns:

Map containing text found in estimated table cells

Throws:

PdfException - If the co-ordinates are not valid

extractTextAsWordlist

protected final List<String> extractTextAsWordlist(int x1,
                                                   int y1,
                                                   int x2,
                                                   int y2,
                                                   int page_number,
                                                   boolean breakFragments,
                                                   String punctuation)
                                            throws PdfException

Algorithm to place data from within coordinates to a vector of word, word coords (x1,y1,x2,y2)

Parameters:

x1 - is the x coord of the top left corner

y1 - is the y coord of the top left corner

x2 - is the x coord of the bottom right corner

y2 - is the y coord of the bottom right corner

page_number - is the page you wish to extract from

breakFragments - will divide up text based on white space characters

punctuation - is a string containing all values that should be used to divide up words

Returns:

Vector containing words found and words coordinates (word, x1,y1,x2,y2...)

Throws:

PdfException - If the co-ordinates are not valid

extractTextInRectangle

protected final String extractTextInRectangle(int x1,
                                              int y1,
                                              int x2,
                                              int y2,
                                              int page_number,
                                              boolean estimateParagraphs,
                                              boolean breakFragments)
                                       throws PdfException

Algorithm to place data from specified coordinates on a page into a String.

Parameters:

x1 - is the x coord of the top left corner

y1 - is the y coord of the top left corner

x2 - is the x coord of the bottom right corner

y2 - is the y coord of the bottom right corner

page_number - is the page you wish to extract from

estimateParagraphs - will attempt to find paragraphs and add new lines in output if true

breakFragments - will divide up text based on white space characters if true

Returns:

Vector containing words found and words coordinates (word, x1,y1,x2,y2...)

Throws:

PdfException - If the co-ordinates are not valid