Class SynchronizedMetaDataValidation
- java.lang.Object
-
- org.apache.pdfbox.preflight.metadata.SynchronizedMetaDataValidation
-
public class SynchronizedMetaDataValidation extends java.lang.ObjectClass which checks if document information available in a document is synchronized with XMP- Author:
- Germain Costenobel
-
-
Constructor Summary
Constructors Constructor Description SynchronizedMetaDataValidation()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ValidationResult.ValidationErrorabsentSchemaMetaDataError(java.lang.String target, java.lang.String schema)Return a formatted validation error when a specific metadata schema can't be foundprotected ValidationResult.ValidationErrorabsentXMPPropertyError(java.lang.String target, java.lang.String details)Return a formatted validation error when a specific XMP property can't be foundprotected voidanalyzeAuthorProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.DublinCoreSchema dc, java.util.List<ValidationResult.ValidationError> ve)Analyze if Author(s) embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeCreationDateProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.XMPBasicSchema xmp, java.util.List<ValidationResult.ValidationError> ve)Analyze if the CreationDate embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeCreatorToolProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.XMPBasicSchema xmp, java.util.List<ValidationResult.ValidationError> ve)Analyze if the creator tool embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeKeywordsProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.AdobePDFSchema pdf, java.util.List<ValidationResult.ValidationError> ve)Analyze if Keyword(s) embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeModifyDateProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.XMPBasicSchema xmp, java.util.List<ValidationResult.ValidationError> ve)Analyze if the ModifyDate embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeProducerProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.AdobePDFSchema pdf, java.util.List<ValidationResult.ValidationError> ve)Analyze if Producer embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeSubjectProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.DublinCoreSchema dc, java.util.List<ValidationResult.ValidationError> ve)Analyze if Subject(s) embedded in Document Information dictionary and in XMP properties are synchronizedprotected voidanalyzeTitleProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.DublinCoreSchema dc, java.util.List<ValidationResult.ValidationError> ve)Analyze if Title embedded in Document Information dictionary and in XMP properties are synchronizedprotected ValidationResult.ValidationErrorbadFieldXMPPropertyError(java.lang.String target, java.lang.String details)Return a formatted validation error when a specific XMP property has the wrong type.protected ValidationExceptionschemaAccessException(java.lang.String target, java.lang.Throwable cause)Return an exception formatted on IOException when accessing on metadata schemaprotected ValidationResult.ValidationErrorunexpectedPrefixFoundError(java.lang.String prefFound, java.lang.String prefExpected, java.lang.String schema)Return a validationError formatted when a schema has not the expected prefixprotected ValidationResult.ValidationErrorunsynchronizedMetaDataError(java.lang.String target)Return a formatted validation error when metadata are not synchronizedjava.util.List<ValidationResult.ValidationError>validateMetadataSynchronization(org.apache.pdfbox.pdmodel.PDDocument document, org.apache.xmpbox.XMPMetadata metadata)Check if document information entries and XMP information are synchronized
-
-
-
Method Detail
-
analyzeTitleProperty
protected void analyzeTitleProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.DublinCoreSchema dc, java.util.List<ValidationResult.ValidationError> ve)Analyze if Title embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- the Document Information Dictionary.dc- the Dublin Core Schema.ve- the list of validation errors.
-
analyzeAuthorProperty
protected void analyzeAuthorProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.DublinCoreSchema dc, java.util.List<ValidationResult.ValidationError> ve)Analyze if Author(s) embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionarydc- Dublin Core Schemave- The list of validation errors
-
analyzeSubjectProperty
protected void analyzeSubjectProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.DublinCoreSchema dc, java.util.List<ValidationResult.ValidationError> ve)Analyze if Subject(s) embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionarydc- Dublin Core Schemave- The list of validation errors
-
analyzeKeywordsProperty
protected void analyzeKeywordsProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.AdobePDFSchema pdf, java.util.List<ValidationResult.ValidationError> ve)Analyze if Keyword(s) embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionarypdf- PDF Schemave- The list of validation errors
-
analyzeProducerProperty
protected void analyzeProducerProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.AdobePDFSchema pdf, java.util.List<ValidationResult.ValidationError> ve)Analyze if Producer embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionarypdf- PDF Schemave- The list of validation errors
-
analyzeCreatorToolProperty
protected void analyzeCreatorToolProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.XMPBasicSchema xmp, java.util.List<ValidationResult.ValidationError> ve)Analyze if the creator tool embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionaryxmp- XMP Basic Schemave- The list of validation errors
-
analyzeCreationDateProperty
protected void analyzeCreationDateProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.XMPBasicSchema xmp, java.util.List<ValidationResult.ValidationError> ve) throws ValidationExceptionAnalyze if the CreationDate embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionaryxmp- XMP Basic Schemave- The list of validation errors- Throws:
ValidationException
-
analyzeModifyDateProperty
protected void analyzeModifyDateProperty(org.apache.pdfbox.pdmodel.PDDocumentInformation dico, org.apache.xmpbox.schema.XMPBasicSchema xmp, java.util.List<ValidationResult.ValidationError> ve) throws ValidationExceptionAnalyze if the ModifyDate embedded in Document Information dictionary and in XMP properties are synchronized- Parameters:
dico- Document Information Dictionaryxmp- XMP Basic Schemave- The list of validation errors- Throws:
ValidationException
-
validateMetadataSynchronization
public java.util.List<ValidationResult.ValidationError> validateMetadataSynchronization(org.apache.pdfbox.pdmodel.PDDocument document, org.apache.xmpbox.XMPMetadata metadata) throws ValidationException
Check if document information entries and XMP information are synchronized- Parameters:
document- the PDF Documentmetadata- the XMP MetaData- Returns:
- List of validation errors
- Throws:
ValidationException
-
unexpectedPrefixFoundError
protected ValidationResult.ValidationError unexpectedPrefixFoundError(java.lang.String prefFound, java.lang.String prefExpected, java.lang.String schema)
Return a validationError formatted when a schema has not the expected prefix- Parameters:
prefFound-prefExpected-schema-- Returns:
- the generated validation error.
-
schemaAccessException
protected ValidationException schemaAccessException(java.lang.String target, java.lang.Throwable cause)
Return an exception formatted on IOException when accessing on metadata schema- Parameters:
target- the name of the schemacause- the raised IOException- Returns:
- the generated exception
-
unsynchronizedMetaDataError
protected ValidationResult.ValidationError unsynchronizedMetaDataError(java.lang.String target)
Return a formatted validation error when metadata are not synchronized- Parameters:
target- the concerned property- Returns:
- the generated validation error
-
absentSchemaMetaDataError
protected ValidationResult.ValidationError absentSchemaMetaDataError(java.lang.String target, java.lang.String schema)
Return a formatted validation error when a specific metadata schema can't be found- Parameters:
target- the concerned propertyschema- the XMP schema which can't be found- Returns:
- the generated validation error
-
absentXMPPropertyError
protected ValidationResult.ValidationError absentXMPPropertyError(java.lang.String target, java.lang.String details)
Return a formatted validation error when a specific XMP property can't be found- Parameters:
target- the concerned propertydetails- comments about the XMP property- Returns:
- the generated validation error
-
badFieldXMPPropertyError
protected ValidationResult.ValidationError badFieldXMPPropertyError(java.lang.String target, java.lang.String details)
Return a formatted validation error when a specific XMP property has the wrong type.- Parameters:
target- the concerned propertydetails- comments about the XMP property- Returns:
- the generated validation error
-
-