org.jpedal.grouping

Class PdfGroupingAlgorithms

java.lang.Object

org.jpedal.grouping.PdfGroupingAlgorithms

public class PdfGroupingAlgorithms
extends Object

Applies heuristics to unstructured PDF text to create content

Field Summary

Fields

Modifier and Type	Field and Description
static char	MARKER2
static boolean	useUnrotatedCoords

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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 -
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)
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.
List	findMultipleTermsInRectangle(int x1, int y1, int x2, int y2, int rotation, String[] terms, boolean orderResults, int searchType, SearchListener listener) Algorithm to find multiple text terms in x1,y1,x2,y2 rectangle on page_number.
SortedMap	findMultipleTermsInRectangleWithMatchingTeasers(int x1, int y1, int x2, int y2, int rotation, String[] terms, int searchType, SearchListener listener) Algorithm to find multiple text terms in x1,y1,x2,y2 rectangle on page_number, with matching teaser.
float[]	findText(int x1, int y1, int x2, int y2, String[] terms, int searchType) Search a particular area with in pdf page currently loaded and return the areas of the results found as an array of float values.
float[]	findText(String[] terms, int searchType) Search with in pdf page currently loaded and return the areas of the results found as an array of float values.
SortedMap	findTextWithinInAreaWithTeasers(int x1, int y1, int x2, int y2, int rotation, String[] terms, int searchType, SearchListener listener) Method to search a specified area on a specified page for a search term.
void	generateTeasers() tell find text to generate teasers as well
String[]	getTeasers() return text teasers from findtext if generateTeasers() called before find
static String	removeHiddenMarkers(String contents) method to show data without encoding
void	setIncludeHTML(boolean value) sets if we include HTML in teasers (do we want this is word or this is word as teaser)

Methods inherited from class java.lang.Object

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

Field Detail

MARKER2

public static final char MARKER2

useUnrotatedCoords

public static boolean useUnrotatedCoords

Constructor Detail

PdfGroupingAlgorithms

public PdfGroupingAlgorithms(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

setIncludeHTML

public void setIncludeHTML(boolean value)

sets if we include HTML in teasers (do we want this is word or this is word as teaser)

Parameters:

value - true to use HTML in teasers, otherwise false

removeHiddenMarkers

public static String removeHiddenMarkers(String contents)

method to show data without encoding

extractTextAsTable

public 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

public 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

public 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

findMultipleTermsInRectangleWithMatchingTeasers

public SortedMap findMultipleTermsInRectangleWithMatchingTeasers(int x1,
                                                                 int y1,
                                                                 int x2,
                                                                 int y2,
                                                                 int rotation,
                                                                 String[] terms,
                                                                 int searchType,
                                                                 SearchListener listener)
                                                          throws PdfException

Algorithm to find multiple text terms in x1,y1,x2,y2 rectangle on page_number, with matching teaser. The teaser is a section of text that start before the result and ends after, should a teaser not be discovered it will instead be set to the search results text.

Parameters:

x1 - the left x cord

y1 - the upper y cord

x2 - the right x cord

y2 - the lower y cord

rotation - the rotation of the page to be searched

terms - the terms to search for

searchType - searchType the search type made up from one or more constants obtained from the SearchType class

listener - an implementation of SearchListener is required, this is to enable searching to be cancelled

Returns:

a SortedMap containing a collection of Rectangle describing the location of found text, mapped to a String which is the matching teaser

Throws:

PdfException - If the co-ordinates are not valid

findTextWithinInAreaWithTeasers

public SortedMap findTextWithinInAreaWithTeasers(int x1,
                                                 int y1,
                                                 int x2,
                                                 int y2,
                                                 int rotation,
                                                 String[] terms,
                                                 int searchType,
                                                 SearchListener listener)
                                          throws PdfException

Method to search a specified area on a specified page for a search term. The returned map contains a set of coordinate for found values and a teaser. The teaser is a section of text that start before the result and ends after, should a teaser not be discovered it will instead be set to the search results text.

Parameters:

x1 - the left x cord

y1 - the upper y cord

x2 - the right x cord

y2 - the lower y cord

rotation - the rotation of the page to be searched

terms - the terms to search for

searchType - searchType the search type made up from one or more constants obtained from the SearchType class

listener - an implementation of SearchListener is required, this is to enable searching to be cancelled

Returns:

a SortedMap containing an int[] of coordinates as the key and a String teaser as the value

Throws:

PdfException - If the co-ordinates are not valid

findMultipleTermsInRectangle

public List findMultipleTermsInRectangle(int x1,
                                         int y1,
                                         int x2,
                                         int y2,
                                         int rotation,
                                         String[] terms,
                                         boolean orderResults,
                                         int searchType,
                                         SearchListener listener)
                                  throws PdfException

Algorithm to find multiple text terms in x1,y1,x2,y2 rectangle on page_number.

Parameters:

x1 - the left x cord

y1 - the upper y cord

x2 - the right x cord

y2 - the lower y cord

rotation - the rotation of the page to be searched

terms - the terms to search for

orderResults - if true the list that is returned is ordered to return the resulting rectangles in a logical order descending down the page, if false, rectangles for multiple terms are grouped together.

searchType - searchType the search type made up from one or more constants obtained from the SearchType class

listener - an implementation of SearchListener is required, this is to enable searching to be cancelled

Returns:

a list of Rectangle describing the location of found text

Throws:

PdfException - If the co-ordinates are not valid

findText

public final float[] findText(int x1,
                              int y1,
                              int x2,
                              int y2,
                              String[] terms,
                              int searchType)
                       throws PdfException

Search a particular area with in pdf page currently loaded and return the areas of the results found as an array of float values.

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

terms - : String[] of search terms, each String is treated as a single term

searchType - : int containing bit flags for the search (See class SearchType)

Returns:

the coords of the found text in a float[] where the coords are pdf page coords. The origin of the coords is the bottom left hand corner (on unrotated page) organised in the following order.
[0]=result x1 coord
[1]=result y1 coord
[2]=result x2 coord
[3]=result y2 coord
[4]=either -101 to show that the next text area is the remainder of this word on another line else any other value is ignored.

Throws:

PdfException - when the search encounters incorrect values in the page content that it can not recover from

findText

public final float[] findText(String[] terms,
                              int searchType)
                       throws PdfException

Search with in pdf page currently loaded and return the areas of the results found as an array of float values.

Method to find text in the specified area allowing for the text to be split across multiple lines.

Parameters:

terms - = the text to search for

searchType - = info on how to search the pdf

Returns:

the coords of the found text in a float[] where the coords are pdf page coords. The origin of the coords is the bottom left hand corner (on unrotated page) organised in the following order.
[0]=result x1 coord
[1]=result y1 coord
[2]=result x2 coord
[3]=result y2 coord
[4]=either -101 to show that the next text area is the remainder of this word on another line else any other value is ignored.

Throws:

PdfException - when the search encounters incorrect values in the page content that it can not recover from

getTeasers

public String[] getTeasers()

return text teasers from findtext if generateTeasers() called before find

generateTeasers

public void generateTeasers()

tell find text to generate teasers as well