Class CompareTool

java.lang.Object

com.itextpdf.testutils.CompareTool

public class CompareTool
extends Object

Helper class for tests: uses ghostscript to compare PDFs at a pixel level.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	CompareTool.CmpMarkedContentRenderFilter
(package private) class	CompareTool.CmpPngFileFilter
(package private) class	CompareTool.CmpTaggedPdfReaderTool
protected class	CompareTool.CompareResult
(package private) class	CompareTool.ImageNameComparator
private class	CompareTool.ObjectPath
(package private) class	CompareTool.PngFileFilter
private static class	CompareTool.SafeEmptyEntityResolver

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	absoluteError
private static final String	cannotOpenTargetDirectory
private String	cmpImage
(package private) List<PdfDictionary>	cmpPages
(package private) List<RefKey>	cmpPagesRef
private String	cmpPdf
private String	cmpPdfName
private int	compareByContentErrorsLimit
private String	compareExec
private final String	compareParams
private static final String	differentPages
private double	floatComparisonError
private boolean	generateCompareByContentXmlReport
private String	gsExec
private static final String	gsFailed
private final String	gsParams
private static final String	ignoredAreasPrefix
private String	outImage
(package private) List<PdfDictionary>	outPages
(package private) List<RefKey>	outPagesRef
private String	outPdf
private String	outPdfName
private static final Pattern	pageListRegexp
private static final String	pageNumberPattern
private static final String	renderedImageExtension
private static final String	tempFilePrefix
private static final String	undefinedGsPath
private static final String	unexpectedNumberOfPages
private String	xmlReportName

Constructor Summary

Constructors

Constructor	Description
CompareTool()

Method Summary

Modifier and Type	Method	Description
private void	addPagesFromDict(PdfObject dictRef, List<PdfDictionary> pages, List<RefKey> pagesRef)
String	compare(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix)
String	compare(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix, Map<Integer, List<Rectangle>> ignoredAreas)
private String	compare(String outPath, String differenceImagePrefix, Map<Integer, List<Rectangle>> ignoredAreas)
private String	compare(String outPath, String differenceImagePrefix, Map<Integer, List<Rectangle>> ignoredAreas, List<Integer> equalPages)
boolean	compareArrays(PdfArray outArray, PdfArray cmpArray)
private boolean	compareArraysExtended(PdfArray outArray, PdfArray cmpArray, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
boolean	compareBooleans(PdfBoolean outBoolean, PdfBoolean cmpBoolean)
private boolean	compareBooleansExtended(PdfBoolean outBoolean, PdfBoolean cmpBoolean, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
String	compareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix)
String	compareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix, Map<Integer, List<Rectangle>> ignoredAreas)
protected String	compareByContent(String outPath, String differenceImagePrefix, Map<Integer, List<Rectangle>> ignoredAreas)
boolean	compareContentStreamsByParsing(PdfObject outObj, PdfObject cmpObj)
boolean	compareContentStreamsByParsing(PdfObject outObj, PdfObject cmpObj, PdfDictionary outResources, PdfDictionary cmpResources)
private boolean	compareContentStreamsByParsingExtended(PdfObject outObj, PdfObject cmpObj, PdfDictionary outResources, PdfDictionary cmpResources, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
boolean	compareDictionaries(PdfDictionary outDict, PdfDictionary cmpDict)
private boolean	compareDictionariesExtended(PdfDictionary outDict, PdfDictionary cmpDict, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
String	compareDocumentInfo(String outPdf, String cmpPdf)
private boolean	compareInlineImagesExtended(PdfContentParser outPs, PdfContentParser cmpPs, PdfDictionary outDict, PdfDictionary cmpDict, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
String	compareLinks(String outPdf, String cmpPdf)
boolean	compareLiterals(PdfLiteral outLiteral, PdfLiteral cmpLiteral)
private boolean	compareLiteralsExtended(PdfLiteral outLiteral, PdfLiteral cmpLiteral, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
boolean	compareNames(PdfName outName, PdfName cmpName)
private boolean	compareNamesExtended(PdfName outName, PdfName cmpName, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
boolean	compareNumbers(PdfNumber outNumber, PdfNumber cmpNumber)
private boolean	compareNumbersExtended(PdfNumber outNumber, PdfNumber cmpNumber, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
private boolean	compareObjects(PdfObject outObj, PdfObject cmpObj, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
boolean	compareStreams(PRStream outStream, PRStream cmpStream)
private boolean	compareStreams(InputStream is1, InputStream is2)
private boolean	compareStreamsExtended(PRStream outStream, PRStream cmpStream, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
boolean	compareStrings(PdfString outString, PdfString cmpString)
private boolean	compareStringsExtended(PdfString outString, PdfString cmpString, CompareTool.ObjectPath currentPath, CompareTool.CompareResult compareResult)
String	compareTagStructures(String outPdf, String cmpPdf)
boolean	compareXmls(byte[] xml1, byte[] xml2)
boolean	compareXmls(String xml1, String xml2)
String	compareXmp(byte[] xmp1, byte[] xmp2)
String	compareXmp(byte[] xmp1, byte[] xmp2, boolean ignoreDateAndProducerProperties)
String	compareXmp(String outPdf, String cmpPdf)
String	compareXmp(String outPdf, String cmpPdf, boolean ignoreDateAndProducerProperties)
private String[]	convertInfo(HashMap<String,String> info)
String	getXmlReportName()
private void	init(String outPdf, String cmpPdf)
private boolean	linksAreSame(PdfAnnotation.PdfImportedLink cmpLink, PdfAnnotation.PdfImportedLink outLink)
private void	loadPagesFromReader(PdfReader reader, List<PdfDictionary> pages, List<RefKey> pagesRef)
private int	runGhostscriptAndGetExitCode(String replacementPdf, String replacementImagesDirectory)
CompareTool	setCompareByContentErrorsLimit(int compareByContentMaxErrorCount)	Sets the maximum errors count which will be returned as the result of the comparison.
CompareTool	setFloatAbsoluteError(float error)	Sets the absolute error parameter which will be used in floating point numbers comparison.
CompareTool	setFloatRelativeError(float error)	Sets the relative error parameter which will be used in floating point numbers comparison.
void	setGenerateCompareByContentXmlReport(boolean generateCompareByContentXmlReport)
void	setXmlReportName(String xmlReportName)

Methods inherited from class Object

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

Field Details

gsExec

private String gsExec

compareExec

private String compareExec

renderedImageExtension

private static final String renderedImageExtension

See Also:

• Constant Field Values

pageNumberPattern

private static final String pageNumberPattern

See Also:

• Constant Field Values

pageListRegexp

private static final Pattern pageListRegexp

tempFilePrefix

private static final String tempFilePrefix

See Also:

• Constant Field Values

gsParams

private final String gsParams

See Also:

• Constant Field Values

compareParams

private final String compareParams

See Also:

• Constant Field Values

cannotOpenTargetDirectory

private static final String cannotOpenTargetDirectory

See Also:

• Constant Field Values

gsFailed

private static final String gsFailed

See Also:

• Constant Field Values

unexpectedNumberOfPages

private static final String unexpectedNumberOfPages

See Also:

• Constant Field Values

differentPages

private static final String differentPages

See Also:

• Constant Field Values

undefinedGsPath

private static final String undefinedGsPath

See Also:

• Constant Field Values

ignoredAreasPrefix

private static final String ignoredAreasPrefix

See Also:

• Constant Field Values

cmpPdf

private String cmpPdf

cmpPdfName

private String cmpPdfName

cmpImage

private String cmpImage

outPdf

private String outPdf

outPdfName

private String outPdfName

outImage

private String outImage

outPages

List<PdfDictionary> outPages

outPagesRef

List<RefKey> outPagesRef

cmpPages

List<PdfDictionary> cmpPages

cmpPagesRef

List<RefKey> cmpPagesRef

compareByContentErrorsLimit

private int compareByContentErrorsLimit

generateCompareByContentXmlReport

private boolean generateCompareByContentXmlReport

xmlReportName

private String xmlReportName

floatComparisonError

private double floatComparisonError

absoluteError

private boolean absoluteError

Constructor Details

CompareTool

public CompareTool()

Method Details

compare

private String compare(String outPath,
 String differenceImagePrefix,
 Map<Integer, List<Rectangle>> ignoredAreas)
                throws IOException,
InterruptedException,
DocumentException

Throws:

IOException

InterruptedException

DocumentException

compare

private String compare(String outPath,
 String differenceImagePrefix,
 Map<Integer, List<Rectangle>> ignoredAreas,
 List<Integer> equalPages)
                throws IOException,
InterruptedException,
DocumentException

Throws:

IOException

InterruptedException

DocumentException

runGhostscriptAndGetExitCode

private int runGhostscriptAndGetExitCode(String replacementPdf,
 String replacementImagesDirectory)
                                  throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

compare

public String compare(String outPdf,
 String cmpPdf,
 String outPath,
 String differenceImagePrefix,
 Map<Integer, List<Rectangle>> ignoredAreas)
               throws IOException,
InterruptedException,
DocumentException

Throws:

IOException

InterruptedException

DocumentException

compare

public String compare(String outPdf,
 String cmpPdf,
 String outPath,
 String differenceImagePrefix)
               throws IOException,
InterruptedException,
DocumentException

Throws:

IOException

InterruptedException

DocumentException

setCompareByContentErrorsLimit

public CompareTool setCompareByContentErrorsLimit(int compareByContentMaxErrorCount)

Sets the maximum errors count which will be returned as the result of the comparison.

Parameters:

compareByContentMaxErrorCount - the errors count.

Returns:

Returns this.

setGenerateCompareByContentXmlReport

public void setGenerateCompareByContentXmlReport(boolean generateCompareByContentXmlReport)

setFloatAbsoluteError

public CompareTool setFloatAbsoluteError(float error)

Sets the absolute error parameter which will be used in floating point numbers comparison.

Parameters:

error - the epsilon new value.

Returns:

Returns this.

setFloatRelativeError

public CompareTool setFloatRelativeError(float error)

Sets the relative error parameter which will be used in floating point numbers comparison.

Parameters:

error - the epsilon new value.

Returns:

Returns this.

getXmlReportName

public String getXmlReportName()

setXmlReportName

public void setXmlReportName(String xmlReportName)

compareByContent

protected String compareByContent(String outPath,
 String differenceImagePrefix,
 Map<Integer, List<Rectangle>> ignoredAreas)
                           throws DocumentException,
InterruptedException,
IOException

Throws:

DocumentException

InterruptedException

IOException

compareByContent

public String compareByContent(String outPdf,
 String cmpPdf,
 String outPath,
 String differenceImagePrefix,
 Map<Integer, List<Rectangle>> ignoredAreas)
                        throws DocumentException,
InterruptedException,
IOException

Throws:

DocumentException

InterruptedException

IOException

compareByContent

public String compareByContent(String outPdf,
 String cmpPdf,
 String outPath,
 String differenceImagePrefix)
                        throws DocumentException,
InterruptedException,
IOException

Throws:

DocumentException

InterruptedException

IOException

loadPagesFromReader

private void loadPagesFromReader(PdfReader reader,
 List<PdfDictionary> pages,
 List<RefKey> pagesRef)

addPagesFromDict

private void addPagesFromDict(PdfObject dictRef,
 List<PdfDictionary> pages,
 List<RefKey> pagesRef)

compareObjects

private boolean compareObjects(PdfObject outObj,
 PdfObject cmpObj,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)
                        throws IOException

Throws:

IOException

compareDictionaries

public boolean compareDictionaries(PdfDictionary outDict,
 PdfDictionary cmpDict)
                            throws IOException

Throws:

IOException

compareDictionariesExtended

private boolean compareDictionariesExtended(PdfDictionary outDict,
 PdfDictionary cmpDict,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)
                                     throws IOException

Throws:

IOException

compareContentStreamsByParsing

public boolean compareContentStreamsByParsing(PdfObject outObj,
 PdfObject cmpObj)
                                       throws IOException

Throws:

IOException

compareContentStreamsByParsing

public boolean compareContentStreamsByParsing(PdfObject outObj,
 PdfObject cmpObj,
 PdfDictionary outResources,
 PdfDictionary cmpResources)
                                       throws IOException

Throws:

IOException

compareContentStreamsByParsingExtended

private boolean compareContentStreamsByParsingExtended(PdfObject outObj,
 PdfObject cmpObj,
 PdfDictionary outResources,
 PdfDictionary cmpResources,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)
                                                throws IOException

Throws:

IOException

compareInlineImagesExtended

private boolean compareInlineImagesExtended(PdfContentParser outPs,
 PdfContentParser cmpPs,
 PdfDictionary outDict,
 PdfDictionary cmpDict,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)
                                     throws IOException

Throws:

IOException

compareStreams

public boolean compareStreams(PRStream outStream,
 PRStream cmpStream)
                       throws IOException

Throws:

IOException

compareStreamsExtended

private boolean compareStreamsExtended(PRStream outStream,
 PRStream cmpStream,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)
                                throws IOException

Throws:

IOException

compareArrays

public boolean compareArrays(PdfArray outArray,
 PdfArray cmpArray)
                      throws IOException

Throws:

IOException

compareArraysExtended

private boolean compareArraysExtended(PdfArray outArray,
 PdfArray cmpArray,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)
                               throws IOException

Throws:

IOException

compareNames

public boolean compareNames(PdfName outName,
 PdfName cmpName)

compareNamesExtended

private boolean compareNamesExtended(PdfName outName,
 PdfName cmpName,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)

compareNumbers

public boolean compareNumbers(PdfNumber outNumber,
 PdfNumber cmpNumber)

compareNumbersExtended

private boolean compareNumbersExtended(PdfNumber outNumber,
 PdfNumber cmpNumber,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)

compareStrings

public boolean compareStrings(PdfString outString,
 PdfString cmpString)

compareStringsExtended

private boolean compareStringsExtended(PdfString outString,
 PdfString cmpString,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)

compareLiterals

public boolean compareLiterals(PdfLiteral outLiteral,
 PdfLiteral cmpLiteral)

compareLiteralsExtended

private boolean compareLiteralsExtended(PdfLiteral outLiteral,
 PdfLiteral cmpLiteral,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)

compareBooleans

public boolean compareBooleans(PdfBoolean outBoolean,
 PdfBoolean cmpBoolean)

compareBooleansExtended

private boolean compareBooleansExtended(PdfBoolean outBoolean,
 PdfBoolean cmpBoolean,
 CompareTool.ObjectPath currentPath,
 CompareTool.CompareResult compareResult)

compareXmp

public String compareXmp(byte[] xmp1,
 byte[] xmp2)

compareXmp

public String compareXmp(byte[] xmp1,
 byte[] xmp2,
 boolean ignoreDateAndProducerProperties)

compareXmp

public String compareXmp(String outPdf,
 String cmpPdf)

compareXmp

public String compareXmp(String outPdf,
 String cmpPdf,
 boolean ignoreDateAndProducerProperties)

compareXmls

public boolean compareXmls(byte[] xml1,
 byte[] xml2)
                    throws ParserConfigurationException,
SAXException,
IOException

Throws:

ParserConfigurationException

SAXException

IOException

compareDocumentInfo

public String compareDocumentInfo(String outPdf,
 String cmpPdf)
                           throws IOException

Throws:

IOException

linksAreSame

private boolean linksAreSame(PdfAnnotation.PdfImportedLink cmpLink,
 PdfAnnotation.PdfImportedLink outLink)

compareLinks

public String compareLinks(String outPdf,
 String cmpPdf)
                    throws IOException

Throws:

IOException

compareTagStructures

public String compareTagStructures(String outPdf,
 String cmpPdf)
                            throws IOException,
ParserConfigurationException,
SAXException

Throws:

IOException

ParserConfigurationException

SAXException

convertInfo

private String[] convertInfo(HashMap<String,String> info)

compareXmls

public boolean compareXmls(String xml1,
 String xml2)
                    throws ParserConfigurationException,
SAXException,
IOException

Throws:

ParserConfigurationException

SAXException

IOException

init

private void init(String outPdf,
 String cmpPdf)

compareStreams

private boolean compareStreams(InputStream is1,
 InputStream is2)
                        throws IOException

Throws:

IOException