com.qoppa.pdfText

Class PDFText

java.lang.Object

com.qoppa.pdfText.PDFText

public class PDFText
extends Object

PDFText is the class to extract the list of words contained in a PDF document as a Vector. It also returns the DocumentInfo for the document as well as the page count.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFText.KeyInfoText This is the Main-Class for the jPDFText.jar that can generate server key requests, validate a key, and display server information.

Constructor Summary

Constructors

Constructor and Description
PDFText(InputStream inStream, IPassword password) Creates a PDFText object from a PDF InputStream.
PDFText(String fileName, IPassword password) Loads a PDFText object from a file.
PDFText(URL url, IPassword password) Loads a PDFText object from a URL.

Method Summary

Modifier and Type	Method and Description
void	close() Close / release all resources held by this document.
Vector<TextPosition>	findText(int pageIndex, String searchText, boolean caseSensitive, boolean wholeWords) Searches a page for text and returns a list of TextPosition objects for each of the occurrences of the string in the page.
DocumentInfo	getDocumentInfo() Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
static DocumentInfo	getDocumentInfo(InputStream inStream, IPassword password) Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
String	getFileName() Returns the name of the pdf document.
Vector<TextPosition>	getLinesWithPositions(int pageIndex) Returns position information for all the lines of text in the specified page of the PDF document.
int	getPageCount() Returns the number of pages of the pdf document.
String	getText() Returns the text in the pdf document as a String.
String	getText(int pageIndex) Returns text contained in the specified page of the pdf document as a String.
String	getTextInArea(int pageIndex, Rectangle2D textArea) Returns text contained in an area of a page
String	getTextWithCursors(int pageIndex, Point2D startCursor, Point2D endCursor) Returns the text contained between the start and end cursors, in "reading mode".
static String	getVersion() Returns version string for jPDFText.
Vector<String>	getWords() Returns all words in the pdf document as a Vector of Strings.
Vector<String>	getWords(int pageIndex) Returns all words contained in the specified page of the pdf document as a Vector of Strings.
Vector<TextPosition>	getWordsWithPositions(int pageIndex) Returns position information for all the words in the specified page of the PDF document.
Vector<TextPosition>	getWordsWithPositions(int pageIndex, String wordSeparators) Returns position information for all the words in the specified page of the PDF document, given a set of word separators.
static void	loadLicense(InputStream licenseStream) Method to load a license file from an inputstream.
static void	loadLicense(String licenseFile) Method to load a license file.
static boolean	setAppletKey(String key, Applet applet) Method to unlock the production version of the library.
static boolean	setKey(String key) Method to unlock the production version of the library.
boolean	usePermissionsPassword(String password) Tells the PDFText object that the permissions password is known, so all permissions are granted.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFText

public PDFText(InputStream inStream,
               IPassword password)
        throws PDFException

Creates a PDFText object from a PDF InputStream.

Parameters:

inStream - InputStream to read the pdf document from.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFText

public PDFText(String fileName,
               IPassword password)
        throws PDFException

Loads a PDFText object from a file.

Parameters:

fileName - Name of the PDF file.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFText

public PDFText(URL url,
               IPassword password)
        throws PDFException

Loads a PDFText object from a URL.

Parameters:

url - URL pointint to the location of the PDF file.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

Method Detail

getDocumentInfo

public DocumentInfo getDocumentInfo()

Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)

getDocumentInfo

public static DocumentInfo getDocumentInfo(InputStream inStream,
                                           IPassword password)
                                    throws PDFException

Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)

Parameters:

inStream - InputStream to read the pdf document from.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

getFileName

public String getFileName()

Returns the name of the pdf document.

getPageCount

public int getPageCount()

Returns the number of pages of the pdf document.

getText

public String getText()
               throws PDFException

Returns the text in the pdf document as a String. Pages are separated with a return char.

Returns:

Text contained in the pdf document as String.

Throws:

PDFException

getText

public String getText(int pageIndex)
               throws PDFException

Returns text contained in the specified page of the pdf document as a String.

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

Returns:

Text contained in the specified page as a String.

Throws:

PDFException

getTextInArea

public String getTextInArea(int pageIndex,
                            Rectangle2D textArea)
                     throws PDFException

Returns text contained in an area of a page

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

textArea - the area of the page to get text from.

Returns:

A String containing the text in the area. If there is no text, this method will return null.

Throws:

PDFException

getTextWithCursors

public String getTextWithCursors(int pageIndex,
                                 Point2D startCursor,
                                 Point2D endCursor)
                          throws PDFException

Returns the text contained between the start and end cursors, in "reading mode". Reading mode implies line wrapping, column detection and wrapping and more. The effect should be the same as if the user chose the text selection tool, pressed down at the startCursor location and dragged to the endCursor location.

Parameters:

startCursor - the location where the cursor should start selection

endCursor - The location where the cursor ends selection

Returns:

A TextSelection object representing the text that was selected.

Throws:

PDFException

setAppletKey

public static boolean setAppletKey(String key,
                                   Applet applet)

Method to unlock the production version of the library.

Parameters:

key - Production key.

setKey

public static boolean setKey(String key)

Method to unlock the production version of the library.

Parameters:

key - Production key.

loadLicense

public static void loadLicense(InputStream licenseStream)
                        throws LicenseException

Method to load a license file from an inputstream. This is useful when the license file is placed in the classpath of the host application and an input stream can be opened to it as a resource.

Parameters:

licenseStream - The input stream for the license file contents.

Throws:

LicenseException - If there are any problems with the license file

loadLicense

public static void loadLicense(String licenseFile)
                        throws LicenseException,
                               IOException

Method to load a license file.

Parameters:

licenseFile - The full path to the license file.

Throws:

LicenseException - If there are any problems with the license file

IOException

getVersion

public static String getVersion()

Returns version string for jPDFText. If this is the demo version, the return string will contain 'Demo Version' at the end.

getWords

public Vector<String> getWords()
                        throws PDFException

Returns all words in the pdf document as a Vector of Strings. The default separators used to separate words are the following: ,/;\n><():?&.@*\t To customize separators, see getWordsWithPositions(int, String)

Returns:

Words contained in the pdf document as a Vector of Strings.

Throws:

PDFException

getWords

public Vector<String> getWords(int pageIndex)
                        throws PDFException

Returns all words contained in the specified page of the pdf document as a Vector of Strings. The default separators used to separate words are the following: ,/;\n><():?&.@*\t To customize separators, see getWordsWithPositions(int, String)

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

Returns:

Words contained in the specified page as a Vector of Strings.

Throws:

PDFException

getLinesWithPositions

public Vector<TextPosition> getLinesWithPositions(int pageIndex)
                                           throws PDFException

Returns position information for all the lines of text in the specified page of the PDF document.

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

Returns:

A Vector of TextPosition objects.

Throws:

PDFException

getWordsWithPositions

public Vector<TextPosition> getWordsWithPositions(int pageIndex)
                                           throws PDFException

Returns position information for all the words in the specified page of the PDF document. The default separators used to separate words are the following: ,/;\n><():?&.@*\t To customize separators, see getWordsWithPositions(int, String)

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

Returns:

A Vector of TextPosition objects.

Throws:

PDFException

getWordsWithPositions

public Vector<TextPosition> getWordsWithPositions(int pageIndex,
                                                  String wordSeparators)
                                           throws PDFException

Returns position information for all the words in the specified page of the PDF document, given a set of word separators.

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

wordSeparators - A list of single character word separators.

Returns:

A Vector of TextPosition objects.

Throws:

PDFException

findText

public Vector<TextPosition> findText(int pageIndex,
                                     String searchText,
                                     boolean caseSensitive,
                                     boolean wholeWords)
                              throws PDFException

Searches a page for text and returns a list of TextPosition objects for each of the occurrences of the string in the page. If there are no occurrences, the method returns a Vector of length 0.

Parameters:

pageIndex - The index of the page to search in

searchText - The text to search for.

caseSensitive - Flag indicating whether the search should be case sensitive.

wholeWords - Flag indicating whether the search should only look at whole words.

Returns:

A list of TextPosition objects.

Throws:

PDFException

usePermissionsPassword

public boolean usePermissionsPassword(String password)
                               throws PDFException

Tells the PDFText object that the permissions password is known, so all permissions are granted.

Parameters:

password - The permissions password

Returns:

true if the password was validated or the document is not encrypted

Throws:

PDFException

close

public void close()

Close / release all resources held by this document. After this method is called, this object becomes invalid and should not be used anymore.