Package eu.europa.esig.dss.pdf.modifications

Class DefaultPdfDifferencesFinder

java.lang.Object

eu.europa.esig.dss.pdf.modifications.DefaultPdfDifferencesFinder

All Implemented Interfaces:

PdfDifferencesFinder

public class DefaultPdfDifferencesFinder
extends Object
implements PdfDifferencesFinder

Default implementation used to find differences in pages between two PDF revisions.

Constructor Summary

Constructors

Constructor	Description
DefaultPdfDifferencesFinder()	Default constructor instantiating object with default configuration

Method Summary

Modifier and Type	Method	Description
List<PdfModification>	getAnnotationOverlaps(PdfDocumentReader reader)	Returns a list of found annotation overlaps
List<PdfModification>	getPagesDifferences(PdfDocumentReader signedRevisionReader, PdfDocumentReader finalRevisionReader)	Returns a list of missing/added pages between signed and final revisions
List<PdfModification>	getVisualDifferences(PdfDocumentReader signedRevisionReader, PdfDocumentReader finalRevisionReader)	Returns a list of visual differences found between signed and final revisions excluding newly created annotations
boolean	isAnnotationBoxOverlapping(AnnotationBox annotationBox, List<PdfAnnotation> pdfAnnotations)	Checks if the given annotationBox overlaps with pdfAnnotations
void	setMaximalPagesAmountForVisualComparison(int pagesAmount)	Sets a maximal pages amount in a PDF to process a visual screenshot comparison Example: for value 10, the visual comparison will be executed for a PDF containing 10 and fewer pages NOTE: In order to disable visual comparison check set the pages amount to 0 (zero) Default : 10 pages

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPdfDifferencesFinder

public DefaultPdfDifferencesFinder()

Default constructor instantiating object with default configuration

Method Details

setMaximalPagesAmountForVisualComparison

public void setMaximalPagesAmountForVisualComparison(int pagesAmount)

Sets a maximal pages amount in a PDF to process a visual screenshot comparison Example: for value 10, the visual comparison will be executed for a PDF containing 10 and fewer pages NOTE: In order to disable visual comparison check set the pages amount to 0 (zero) Default : 10 pages

Parameters:

pagesAmount - the amount of the pages to execute visual comparison for

getAnnotationOverlaps

public List<PdfModification> getAnnotationOverlaps(PdfDocumentReader reader)

Description copied from interface: PdfDifferencesFinder

Returns a list of found annotation overlaps

Specified by:

getAnnotationOverlaps in interface PdfDifferencesFinder

Parameters:

reader - PdfDocumentReader the complete PDF document reader

Returns:

a list of PdfModifications

isAnnotationBoxOverlapping

public boolean isAnnotationBoxOverlapping(AnnotationBox annotationBox,
 List<PdfAnnotation> pdfAnnotations)

Description copied from interface: PdfDifferencesFinder

Checks if the given annotationBox overlaps with pdfAnnotations

Specified by:

isAnnotationBoxOverlapping in interface PdfDifferencesFinder

Parameters:

annotationBox - AnnotationBox to check

pdfAnnotations - a list of PdfAnnotation to validate against

Returns:

TRUE when annotationBox overlaps with at least one element from otherAnnotations list, FALSE otherwise

getPagesDifferences

public List<PdfModification> getPagesDifferences(PdfDocumentReader signedRevisionReader,
 PdfDocumentReader finalRevisionReader)

Description copied from interface: PdfDifferencesFinder

Returns a list of missing/added pages between signed and final revisions

Specified by:

getPagesDifferences in interface PdfDifferencesFinder

Parameters:

signedRevisionReader - PdfDocumentReader for the signed (covered) revision content

finalRevisionReader - PdfDocumentReader for the originally provided document

Returns:

a list of PdfModifications

getVisualDifferences

public List<PdfModification> getVisualDifferences(PdfDocumentReader signedRevisionReader,
 PdfDocumentReader finalRevisionReader)

Description copied from interface: PdfDifferencesFinder

Returns a list of visual differences found between signed and final revisions excluding newly created annotations

Specified by:

getVisualDifferences in interface PdfDifferencesFinder

Parameters:

signedRevisionReader - PdfDocumentReader for the signed (covered) revision content

finalRevisionReader - PdfDocumentReader for the originally provided document

Returns:

a list of PdfModifications