TrapRange: a Method to Extract Table Content in PDF Files

Source: http://www.dzone.com/articles/traprange-method-extract-table

Update

April 25

Support PDFBox 2.0

April 24

Allow running from the command line. Type java -jar traprange.lastest.jar -h for help OR see examples in file test-command-line.sh

Introduction

Table data structure is one of the most important data structures in document, especially when exporting data from systems, data is usually in table format. There are several data file formats are often used to store data including csv, text, and pdf. For the first two formats, it is definitely easy to extract data content by opening files, loop through lines and split cells depending on its cell separator, and of course we already had many libraries that help us to do that work automatically. It's normal work. On the other hand, regarding pdf file, it's not a familiar format to read and process directly from InputStream because it is a complicating file format that can contain not only text data, font, content style, but also image, audio and video [1]. In this post, we are going to describe our solution used to extract table data in pdf files. Our solution was implemented, experimented and adapted with pdf files having high density of table content. The advantages and disadvantages of our solution are also discussed.

How to recognize a table

After some investigation, I realized that:

Column: text content in cells of the same column lies on a rectangular space that does not overlap with other rectangular spaces of another column. For example, in the following image, red rectangle and blue rectangle are separated spaces
Row: words in same horizontal alignment are in the same row. But this is just sufficient condition because a cell in a row may be a multi-line cell. For example, the fourth cell in the yellow rectangle has two lines, phrases “FK to this customer’s record in” and "Ledgers table" are not int same horizontal alignment but they are still considered in the same row. In our solution, we simply assume that content in a cell only is single-line content. Different lines in a cell are considered to belong to different rows. Therefore the content in the yellow rectangle contains two rows: 1. {"Ledger_ID", "|" , "Sales Ledger Account" , "FK to this customer's record to"} 2. {NULL , NULL , NULL , "Ledgers table"}

PDFBox API

My work is based on the data returned by PDFBox API, an open source project. To extract text from a pdf file, PDFBox API provides 4 classes:

PDDocument: contains information of entire pdf file. In order to load a pdf file, we use method PDDocument.load(stream: InputStream)
PDPage: represents for each page in pdf document. We possibly archive a specific page content by passing the index of the page with this method: document.getDocumentCatalog().getAllPages().get(pageIdx: int)
TextPosition: represents an individual word or character in the document. We can fetch all TextPosition objects of a PDPage by overriding method processTextPosition(text: TextPosition) in class PDTextStripper. A TextPosition object has methods getX(), getY(), getWidth(), getHeight() that returns its bound in page and method getCharacter() to get its content.

In my work, I process text chunks directly by using TextPosition objects. For each text chunk in PDF file, it returns a text element with following attributes:

x: horizontal distance from the left of the page
y: vertical distance from the top border of the page
maxX: equals x + width of the text chunk
maxY: equals y+ height of the text chunk

Trap ranges

The most important point of my method is identifying the bound of each row and column in the table, because if we know the bound of a row or a column, we can retrieve all texts in this row or column so that we can extract all content of the table. We name these bounds are trap-ranges. TrapRange has two attributes:

lowerBound: contains the lower endpoint of this range
upperBound: contains the upper endpoint of this range To calculate values of trap-ranges, we loop through all texts of the page and project range of each text onto horizontal and vertical axis, get the result and join them together. After looping through all texts of page, we will calculate trap-ranges and use them to identify cell data of the table.

Algorithm 1: calculating trap-ranges for each pdf page:

columnTrapRanges <-- []
rowTrapRanges <-- []
for each text in page
begin
     columnTrapRanges <-- join(columnTrapRanges, {text.x, text.x + text.width} )
     rowTrapRanges <-- join(rowTrapRanges, {text.y, text.y + text.height} )
end

After calculating trap-ranges for the table, we loop through all texts again and classify them into correct cells of the table.

Algorithm 2: classifying text chunks into correct cells:

table <-- new Table()
for each text in page
begin
     rowIdx <-- in rowTrapRanges, get index of the range that containts this text
     columnIdx <-- in columnTrapRanges, get index of the range that contains this text
     table.addText(text, rowIdx, columnIdx)
end

Design and implement

The above is class diagram that describes main classes in our projects:

TrapRangeBuilder: method build() in this class will calculate and return all trap-ranges corresponding to added ranges
Table, TableRow and TableCell: contain data of extracted table
PDFTableExtractor is the most important class. It contains methods to initialize and extract table data from an input pdf file. Builder pattern was applied for this interface. Following is some important methods in this class:
setSource: set source of the pdf file. It has three versions of this method, including setSource(InputStream), setSource(File) and setSource(String)
addPage: to determine which pages will be extracted table content. If not set, all pages will be extracted
exceptPage: skip a page
exceptLine: this method is used to tell the algorithm that which page contains noisy data instead of table content. All texts in these lines will be avoided.
extract: do extraction and return result

Example

PDFTableExtractor extractor = new PDFTableExtractor();
List<Table> tables = extractor.setSource(“table.pdf”)
	.addPage(0)
	.addPage(1)
	.exceptLine(0) //the first line in each page
	.exceptLine(1) //the second line in each page
	.exceptLine(-1)//the last line in each page
	.extract();
String html = tables.get(0).toHtml();//table in html format
String csv = tables.get(0).toString();//table in csv format using semicolon as a delimiter

Following are some sample results (check out and run the test file TestExtractor.java):

Sample 1: Source: sample-1.pdf, result: sample-1.html
Sample 2: Source: sample-2.pdf, result: sample-2.html
Sample 3: Source: sample-3.pdf, result: sample-3.html
Sample 4: Source: sample-4.pdf, result: sample-4.html
Sample 5: Source: sample-5.pdf, result: sample-5.html

Evaluation

In experimentation, we used pdf files having high density of table data. The results show that our implementation realizes table data better than other open source tools: pdftotext, pdftohtml, pdf2table. With documents having multi tables or too much noisy data, our method does not work or works incorrectly. When a table row has a cell overlaps the space of beside columns, this row will be discarded.

Conclusion

TrapRange method works best with pdf files having high density of table data. With documents have multi-tables or too much noisy data, TrapRange is not a good choice. Our method also can be implemented in other programming language by replacing PDFBox by a corresponding pdf library or using command-line tool pdftohtml to extract text chunks and using these data as input data for algorithm 1, 2.

System requirements

Java 8+
Maven 3+

References

Author and contact

ThoQ Luong

Email: thoqbk@gmail.com

License

The MIT License (MIT)

hitenpratap/traprange