com.testautomationguru.utility

Class PDFUtil

java.lang.Object

com.testautomationguru.utility.PDFUtil

public class PDFUtil
extends Object

PDF Utility

A simple pdf utility using apache pdfbox to get the text, compare files using plain text or pixel by pixel comparison, extract all the images from the pdf

Since:

2015-06-13

Version:

1.0

Author:

www.testautomationguru.com

Constructor Summary

Constructors

Constructor and Description
PDFUtil()

Method Summary

Modifier and Type	Method and Description
boolean	compare(String file1, String file2) Compares two given pdf documents.
boolean	compare(String file1, String file2, int startPage) Compares two given pdf documents.
boolean	compare(String file1, String file2, int startPage, int endPage) Compares two given pdf documents.
boolean	compare(String file1, String file2, int startPage, int endPage, boolean highlightImageDifferences, boolean showAllDifferences) Compare 2 pdf documents pixel by pixel for the content and format.
void	compareAllPages(boolean flag) To compare all the pages of the PDF files.
void	enableLog() This method is used to show log in the console.
void	excludeText(String... regexs)
List<String>	extractImages(String file) Extract all the embedded images from the pdf document
List<String>	extractImages(String file, int startPage) Extract all the embedded images from the pdf document
List<String>	extractImages(String file, int startPage, int endPage) Extract all the embedded images from the pdf document
CompareMode	getCompareMode() This method is used to get the current comparison mode text/visual
String	getImageDestinationPath() Path where images are stored when the savePdfAsImage or extractPdfImages methods are invoked.
int	getPageCount(String file) Get the page count of the document.
String	getText(String file) Get the content of the document as plain text.
String	getText(String file, int startPage) Get the content of the document as plain text.
String	getText(String file, int startPage, int endPage) Get the content of the document as plain text.
void	highlightPdfDifference(boolean flag) Highlight the difference when 2 pdf files are compared in Binary mode.
void	highlightPdfDifference(Color colorCode) Color in which pdf difference can be highlighted.
List<String>	savePdfAsImage(String file) Save each page of the pdf as image
List<String>	savePdfAsImage(String file, int startPage) Save each page of the pdf as image
List<String>	savePdfAsImage(String file, int startPage, int endPage) Save each page of the pdf as image
void	setCompareMode(CompareMode mode) This method is used to change the file comparison mode text/visual
void	setImageDestinationPath(String path) Set the path where images to be stored when the savePdfAsImage or extractPdfImages methods are invoked.
void	setLogLevel(Level level) This method is used to change the level
void	trimWhiteSpace(boolean flag) getText method by default replaces all the white spaces and compares.
void	useStripper(org.apache.pdfbox.text.PDFTextStripper stripper) To modify the text extracting strategy using PDFTextStripper

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFUtil

public PDFUtil()

Method Detail

enableLog

public void enableLog()

This method is used to show log in the console. Level.INFO It is set to Level.OFF by default.

setCompareMode

public void setCompareMode(CompareMode mode)

This method is used to change the file comparison mode text/visual

Parameters:

mode - CompareMode

getCompareMode

public CompareMode getCompareMode()

This method is used to get the current comparison mode text/visual

Returns:

CompareMode

setLogLevel

public void setLogLevel(Level level)

This method is used to change the level

Parameters:

level - java.util.logging.Level

trimWhiteSpace

public void trimWhiteSpace(boolean flag)

getText method by default replaces all the white spaces and compares. This method is used to enable/disable the feature.

Parameters:

flag - true to enable; false otherwise

getImageDestinationPath

public String getImageDestinationPath()

Path where images are stored when the savePdfAsImage or extractPdfImages methods are invoked.

Returns:

String Absolute path where images are stored

setImageDestinationPath

public void setImageDestinationPath(String path)

Set the path where images to be stored when the savePdfAsImage or extractPdfImages methods are invoked.

Parameters:

path - Absolute path to store the images

highlightPdfDifference

public void highlightPdfDifference(boolean flag)

Highlight the difference when 2 pdf files are compared in Binary mode. The result is saved as an image.

Parameters:

flag - true - enable ; false - disable (default);

highlightPdfDifference

public void highlightPdfDifference(Color colorCode)

Color in which pdf difference can be highlighted. MAGENTA is the default color.

Parameters:

colorCode - color code to highlight the difference

compareAllPages

public void compareAllPages(boolean flag)

To compare all the pages of the PDF files. By default as soon as a mismatch is found, the method returns false and exits.

Parameters:

flag - true to enable; false otherwise

useStripper

public void useStripper(org.apache.pdfbox.text.PDFTextStripper stripper)

To modify the text extracting strategy using PDFTextStripper

Parameters:

stripper - Stripper with user strategy

getPageCount

public int getPageCount(String file)
                 throws IOException

Get the page count of the document.

Parameters:

file - Absolute file path

Returns:

int No of pages in the document.

Throws:

IOException - when file is not found.

getText

public String getText(String file)
               throws IOException

Get the content of the document as plain text.

Parameters:

file - Absolute file path

Returns:

String document content in plain text.

Throws:

IOException - when file is not found.

getText

public String getText(String file,
                      int startPage)
               throws IOException

Get the content of the document as plain text.

Parameters:

file - Absolute file path

startPage - Starting page number of the document

Returns:

String document content in plain text.

Throws:

IOException - when file is not found.

getText

public String getText(String file,
                      int startPage,
                      int endPage)
               throws IOException

Get the content of the document as plain text.

Parameters:

file - Absolute file path

startPage - Starting page number of the document

endPage - Ending page number of the document

Returns:

String document content in plain text.

Throws:

IOException - when file is not found.

excludeText

public void excludeText(String... regexs)

compare

public boolean compare(String file1,
                       String file2)
                throws IOException

Compares two given pdf documents. Note : TEXT_MODE : Compare 2 pdf documents contents with no formatting. VISUAL_MODE : Compare 2 pdf documents pixel by pixel for the content and format.

Parameters:

file1 - Absolute file path of the expected file

file2 - Absolute file path of the actual file

Returns:

boolean true if matches, false otherwise

Throws:

IOException - when file is not found.

compare

public boolean compare(String file1,
                       String file2,
                       int startPage,
                       int endPage)
                throws IOException

Compares two given pdf documents. Note : TEXT_MODE : Compare 2 pdf documents contents with no formatting. VISUAL_MODE : Compare 2 pdf documents pixel by pixel for the content and format.

Parameters:

file1 - Absolute file path of the expected file

file2 - Absolute file path of the actual file

startPage - Starting page number of the document

endPage - Ending page number of the document

Returns:

boolean true if matches, false otherwise

Throws:

IOException - when file is not found.

compare

public boolean compare(String file1,
                       String file2,
                       int startPage)
                throws IOException

Compares two given pdf documents. Note : TEXT_MODE : Compare 2 pdf documents contents with no formatting. VISUAL_MODE : Compare 2 pdf documents pixel by pixel for the content and format.

Parameters:

file1 - Absolute file path of the expected file

file2 - Absolute file path of the actual file

startPage - Starting page number of the document

Returns:

boolean true if matches, false otherwise

Throws:

IOException - when file is not found.

savePdfAsImage

public List<String> savePdfAsImage(String file,
                                   int startPage)
                            throws IOException

Save each page of the pdf as image

Parameters:

file - Absolute file path of the file

startPage - Starting page number of the document

Returns:

List list of image file names with absolute path

Throws:

IOException - when file is not found.

savePdfAsImage

public List<String> savePdfAsImage(String file,
                                   int startPage,
                                   int endPage)
                            throws IOException

Save each page of the pdf as image

Parameters:

file - Absolute file path of the file

startPage - Starting page number of the document

endPage - Ending page number of the document

Returns:

List list of image file names with absolute path

Throws:

IOException - when file is not found.

savePdfAsImage

public List<String> savePdfAsImage(String file)
                            throws IOException

Save each page of the pdf as image

Parameters:

file - Absolute file path of the file

Returns:

List list of image file names with absolute path

Throws:

IOException - when file is not found.

compare

public boolean compare(String file1,
                       String file2,
                       int startPage,
                       int endPage,
                       boolean highlightImageDifferences,
                       boolean showAllDifferences)
                throws IOException

Compare 2 pdf documents pixel by pixel for the content and format.

Parameters:

file1 - Absolute file path of the expected file

file2 - Absolute file path of the actual file

startPage - Starting page number of the document

endPage - Ending page number of the document

highlightImageDifferences - To highlight differences in the images

showAllDifferences - To compare all the pages of the PDF (by default as soon as a mismatch is found in a page, this method exits)

Returns:

boolean true if matches, false otherwise

Throws:

IOException - when file is not found.

extractImages

public List<String> extractImages(String file,
                                  int startPage)
                           throws IOException

Extract all the embedded images from the pdf document

Parameters:

file - Absolute file path of the file

startPage - Starting page number of the document

Returns:

List list of image file names with absolute path

Throws:

IOException - when file is not found.

extractImages

public List<String> extractImages(String file,
                                  int startPage,
                                  int endPage)
                           throws IOException

Extract all the embedded images from the pdf document

Parameters:

file - Absolute file path of the file

startPage - Starting page number of the document

endPage - Ending page number of the document

Returns:

List list of image file names with absolute path

Throws:

IOException - when file is not found.

extractImages

public List<String> extractImages(String file)
                           throws IOException

Extract all the embedded images from the pdf document

Parameters:

file - Absolute file path of the file

Returns:

List list of image file names with absolute path

Throws:

IOException - when file is not found.