org.jpedal.grouping

Class PdfSearchUtils

java.lang.Object

org.jpedal.grouping.PdfSearchUtils

public class PdfSearchUtils
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfSearchUtils(PdfData pdf_data)

Method Summary

Modifier and Type	Method and Description
protected void	clearStoredTeasers()
protected 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.
protected 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.
protected void	generateTeasers(boolean value) Flag if teasers should be generated whilst searching
protected String[]	getTeasers() return text teasers from findtext if generateTeasers() called before find
protected boolean	isGeneratingTeasers() Return flag to control teaser generation
protected 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

Constructor Detail

PdfSearchUtils

protected PdfSearchUtils(PdfData pdf_data)

Method Detail

findText

protected 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 - if the page content being search contains invalid data that the search can not recover from

getTeasers

protected String[] getTeasers()

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

Returns:

String[] representing teasers for each result (single of linked areas) in result order

findText

protected 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 - if the page content being search contains invalid data that the search can not recover from

clearStoredTeasers

protected void clearStoredTeasers()

setIncludeHTML

protected 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 include HTML, otherwise false

generateTeasers

protected void generateTeasers(boolean value)

Flag if teasers should be generated whilst searching

Parameters:

value - True to generate teasers, otherwise false

isGeneratingTeasers

protected boolean isGeneratingTeasers()

Return flag to control teaser generation

Returns:

True if teasers are being generated, otherwise false