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

Interface PdfDifferencesFinder

All Known Implementing Classes:

DefaultPdfDifferencesFinder

public interface PdfDifferencesFinder

This interface is used to encounter differences in pages between given PDF revisions.

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

Method Details

getAnnotationOverlaps

List<PdfModification> getAnnotationOverlaps(PdfDocumentReader reader)

Returns a list of found annotation overlaps

Parameters:

reader - PdfDocumentReader the complete PDF document reader

Returns:

a list of PdfModifications

isAnnotationBoxOverlapping

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

Checks if the given annotationBox overlaps with pdfAnnotations

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

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

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

Parameters:

signedRevisionReader - PdfDocumentReader for the signed (covered) revision content

finalRevisionReader - PdfDocumentReader for the originally provided document

Returns:

a list of PdfModifications

getVisualDifferences

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

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

Parameters:

signedRevisionReader - PdfDocumentReader for the signed (covered) revision content

finalRevisionReader - PdfDocumentReader for the originally provided document

Returns:

a list of PdfModifications