Apache PDFBox 3.0.4 · org.apache.pdfbox.preflight.metadata.SynchronizedMetaDataValidation

Access	Constructor and Description
public	SynchronizedMetaDataValidation()

Method Summary

Modifier and Type	Method and Description
protected ValidationResult.ValidationError	Returns: the generated validation error absentSchemaMetaDataError(String the concerned property target, String the XMP schema which can't be found schema) Return a formatted validation error when a specific metadata schema can't be found
protected ValidationResult.ValidationError	Returns: the generated validation error absentXMPPropertyError(String the concerned property target, String comments about the XMP property details) Return a formatted validation error when a specific XMP property can't be found
protected void	analyzeAuthorProperty(PDDocumentInformation Document Information Dictionary dico, DublinCoreSchema Dublin Core Schema dc, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if Author(s) embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeCreationDateProperty(PDDocumentInformation Document Information Dictionary dico, XMPBasicSchema XMP Basic Schema xmp, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if the CreationDate embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeCreatorToolProperty(PDDocumentInformation Document Information Dictionary dico, XMPBasicSchema XMP Basic Schema xmp, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if the creator tool embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeKeywordsProperty(PDDocumentInformation Document Information Dictionary dico, AdobePDFSchema PDF Schema pdf, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if Keyword(s) embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeModifyDateProperty(PDDocumentInformation Document Information Dictionary dico, XMPBasicSchema XMP Basic Schema xmp, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if the ModifyDate embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeProducerProperty(PDDocumentInformation Document Information Dictionary dico, AdobePDFSchema PDF Schema pdf, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if Producer embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeSubjectProperty(PDDocumentInformation Document Information Dictionary dico, DublinCoreSchema Dublin Core Schema dc, List<ValidationResult.ValidationError> The list of validation errors ve) Analyze if Subject(s) embedded in Document Information dictionary and in XMP properties are synchronized
protected void	analyzeTitleProperty(PDDocumentInformation the Document Information Dictionary. dico, DublinCoreSchema the Dublin Core Schema. dc, List<ValidationResult.ValidationError> the list of validation errors. ve) Analyze if Title embedded in Document Information dictionary and in XMP properties are synchronized
protected ValidationResult.ValidationError	Returns: the generated validation error badFieldXMPPropertyError(String the concerned property target, String comments about the XMP property details) Return a formatted validation error when a specific XMP property has the wrong type.
private boolean	Returns: the validation result hasTimeZone(Object date) Verify if the date string has time zone information.
private boolean	Returns: true if the date format is assumed to be valid, false if not. isValidPDFDateFormat(COSBase the date item that is to be checked. item) Verifies that a date item is a COSString and has the format "D:YYYYMMDDHHmmSSOHH'mm'", where D:YYYY is mandatory and the next fields optional, but only if all of their preceding fields are also present.
private String	Returns: the stripped string removeTrailingNul(String to be stripped string) A given string from the DocumentInformation dictionary may have some trailing Nul values which have to be stripped.
protected ValidationException	Returns: the generated exception schemaAccessException(String the name of the schema target, Throwable the raised IOException cause) Return an exception formatted on IOException when accessing on metadata schema
protected ValidationResult.ValidationError	Returns: the generated validation error. unexpectedPrefixFoundError(String prefFound, String prefExpected, String schema) Return a validationError formatted when a schema has not the expected prefix
protected ValidationResult.ValidationError	Returns: the generated validation error unsynchronizedMetaDataError(String the concerned property target) Return a formatted validation error when metadata are not synchronized
public List<ValidationResult.ValidationError>	Returns: List of validation errors validateMetadataSynchronization(PDDocument the PDF Document document, XMPMetadata the XMP MetaData metadata) Check if document information entries and XMP information are synchronized

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Detail

absentSchemaMetaDataError

back to summary

protected ValidationResult.ValidationError absentSchemaMetaDataError(String target, String schema)

Return a formatted validation error when a specific metadata schema can't be found

Parameters

target:String: the concerned property
schema:String: the XMP schema which can't be found

Returns:ValidationResult.ValidationError

the generated validation error

absentXMPPropertyError	back to summary
protected ValidationResult.ValidationError absentXMPPropertyError(String target, String details) Return a formatted validation error when a specific XMP property can't be found Parameters target:String the concerned property details:String comments about the XMP property Returns:ValidationResult.ValidationError the generated validation error

absentXMPPropertyError

back to summary

protected ValidationResult.ValidationError absentXMPPropertyError(String target, String details)

Return a formatted validation error when a specific XMP property can't be found

Parameters

target:String: the concerned property
details:String: comments about the XMP property

Returns:ValidationResult.ValidationError

the generated validation error

analyzeAuthorProperty	back to summary
protected void analyzeAuthorProperty(PDDocumentInformation dico, DublinCoreSchema dc, List<ValidationResult.ValidationError> ve) Analyze if Author(s) embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary dc:DublinCoreSchema Dublin Core Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeAuthorProperty

back to summary

protected void analyzeAuthorProperty(PDDocumentInformation dico, DublinCoreSchema dc, List<ValidationResult.ValidationError> ve)

Analyze if Author(s) embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
dc:DublinCoreSchema: Dublin Core Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeCreationDateProperty	back to summary
protected void analyzeCreationDateProperty(PDDocumentInformation dico, XMPBasicSchema xmp, List<ValidationResult.ValidationError> ve) throws ValidationException Analyze if the CreationDate embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary xmp:XMPBasicSchema XMP Basic Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeCreationDateProperty

back to summary

protected void analyzeCreationDateProperty(PDDocumentInformation dico, XMPBasicSchema xmp, List<ValidationResult.ValidationError> ve) throws ValidationException

Analyze if the CreationDate embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
xmp:XMPBasicSchema: XMP Basic Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeCreatorToolProperty	back to summary
protected void analyzeCreatorToolProperty(PDDocumentInformation dico, XMPBasicSchema xmp, List<ValidationResult.ValidationError> ve) Analyze if the creator tool embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary xmp:XMPBasicSchema XMP Basic Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeCreatorToolProperty

back to summary

protected void analyzeCreatorToolProperty(PDDocumentInformation dico, XMPBasicSchema xmp, List<ValidationResult.ValidationError> ve)

Analyze if the creator tool embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
xmp:XMPBasicSchema: XMP Basic Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeKeywordsProperty	back to summary
protected void analyzeKeywordsProperty(PDDocumentInformation dico, AdobePDFSchema pdf, List<ValidationResult.ValidationError> ve) Analyze if Keyword(s) embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary pdf:AdobePDFSchema PDF Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeKeywordsProperty

back to summary

protected void analyzeKeywordsProperty(PDDocumentInformation dico, AdobePDFSchema pdf, List<ValidationResult.ValidationError> ve)

Analyze if Keyword(s) embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
pdf:AdobePDFSchema: PDF Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeModifyDateProperty	back to summary
protected void analyzeModifyDateProperty(PDDocumentInformation dico, XMPBasicSchema xmp, List<ValidationResult.ValidationError> ve) throws ValidationException Analyze if the ModifyDate embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary xmp:XMPBasicSchema XMP Basic Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeModifyDateProperty

back to summary

protected void analyzeModifyDateProperty(PDDocumentInformation dico, XMPBasicSchema xmp, List<ValidationResult.ValidationError> ve) throws ValidationException

Analyze if the ModifyDate embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
xmp:XMPBasicSchema: XMP Basic Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeProducerProperty	back to summary
protected void analyzeProducerProperty(PDDocumentInformation dico, AdobePDFSchema pdf, List<ValidationResult.ValidationError> ve) Analyze if Producer embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary pdf:AdobePDFSchema PDF Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeProducerProperty

back to summary

protected void analyzeProducerProperty(PDDocumentInformation dico, AdobePDFSchema pdf, List<ValidationResult.ValidationError> ve)

Analyze if Producer embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
pdf:AdobePDFSchema: PDF Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeSubjectProperty	back to summary
protected void analyzeSubjectProperty(PDDocumentInformation dico, DublinCoreSchema dc, List<ValidationResult.ValidationError> ve) Analyze if Subject(s) embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation Document Information Dictionary dc:DublinCoreSchema Dublin Core Schema ve:List<ValidationResult.ValidationError> The list of validation errors

analyzeSubjectProperty

back to summary

protected void analyzeSubjectProperty(PDDocumentInformation dico, DublinCoreSchema dc, List<ValidationResult.ValidationError> ve)

Analyze if Subject(s) embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: Document Information Dictionary
dc:DublinCoreSchema: Dublin Core Schema
ve:List<ValidationResult.ValidationError>: The list of validation errors

analyzeTitleProperty	back to summary
protected void analyzeTitleProperty(PDDocumentInformation dico, DublinCoreSchema dc, List<ValidationResult.ValidationError> ve) Analyze if Title embedded in Document Information dictionary and in XMP properties are synchronized Parameters dico:PDDocumentInformation the Document Information Dictionary. dc:DublinCoreSchema the Dublin Core Schema. ve:List<ValidationResult.ValidationError> the list of validation errors.

analyzeTitleProperty

back to summary

protected void analyzeTitleProperty(PDDocumentInformation dico, DublinCoreSchema dc, List<ValidationResult.ValidationError> ve)

Analyze if Title embedded in Document Information dictionary and in XMP properties are synchronized

Parameters

dico:PDDocumentInformation: the Document Information Dictionary.
dc:DublinCoreSchema: the Dublin Core Schema.
ve:List<ValidationResult.ValidationError>: the list of validation errors.

badFieldXMPPropertyError	back to summary
protected ValidationResult.ValidationError badFieldXMPPropertyError(String target, String details) Return a formatted validation error when a specific XMP property has the wrong type. Parameters target:String the concerned property details:String comments about the XMP property Returns:ValidationResult.ValidationError the generated validation error

badFieldXMPPropertyError

back to summary

protected ValidationResult.ValidationError badFieldXMPPropertyError(String target, String details)

Return a formatted validation error when a specific XMP property has the wrong type.

Parameters

target:String: the concerned property
details:String: comments about the XMP property

Returns:ValidationResult.ValidationError

the generated validation error

hasTimeZone	back to summary
private boolean hasTimeZone(Object date) Verify if the date string has time zone information. This method doesn't do a complete parsing as this is a helper AFTER a date has proven to be valid Returns:boolean the validation result

hasTimeZone

back to summary

private boolean hasTimeZone(Object date)

Verify if the date string has time zone information.

This method doesn't do a complete parsing as this is a helper AFTER a date has proven to be valid

Returns:boolean: the validation result

isValidPDFDateFormat	back to summary
private boolean isValidPDFDateFormat(COSBase item) Verifies that a date item is a COSString and has the format "D:YYYYMMDDHHmmSSOHH'mm'", where D:YYYY is mandatory and the next fields optional, but only if all of their preceding fields are also present. This needs to be done because the other date utilities are too lenient. Parameters item:COSBase the date item that is to be checked. Returns:boolean true if the date format is assumed to be valid, false if not.

isValidPDFDateFormat

back to summary

private boolean isValidPDFDateFormat(COSBase item)

Verifies that a date item is a COSString and has the format "D:YYYYMMDDHHmmSSOHH'mm'", where D:YYYY is mandatory and the next fields optional, but only if all of their preceding fields are also present. This needs to be done because the other date utilities are too lenient.

Parameters

item:COSBase: the date item that is to be checked.

Returns:boolean

true if the date format is assumed to be valid, false if not.

removeTrailingNul	back to summary
private String removeTrailingNul(String string) A given string from the DocumentInformation dictionary may have some trailing Nul values which have to be stripped. Parameters string:String to be stripped Returns:String the stripped string

removeTrailingNul

back to summary

private String removeTrailingNul(String string)

A given string from the DocumentInformation dictionary may have some trailing Nul values which have to be stripped.

Parameters

string:String: to be stripped

Returns:String

the stripped string

schemaAccessException	back to summary
protected ValidationException schemaAccessException(String target, Throwable cause) Return an exception formatted on IOException when accessing on metadata schema Parameters target:String the name of the schema cause:Throwable the raised IOException Returns:ValidationException the generated exception

schemaAccessException

back to summary

protected ValidationException schemaAccessException(String target, Throwable cause)

Return an exception formatted on IOException when accessing on metadata schema

Parameters

target:String: the name of the schema
cause:Throwable: the raised IOException

Returns:ValidationException

the generated exception

unexpectedPrefixFoundError	back to summary
protected ValidationResult.ValidationError unexpectedPrefixFoundError(String prefFound, String prefExpected, String schema) Return a validationError formatted when a schema has not the expected prefix Returns:ValidationResult.ValidationError the generated validation error.

unexpectedPrefixFoundError

back to summary

protected ValidationResult.ValidationError unexpectedPrefixFoundError(String prefFound, String prefExpected, String schema)

Return a validationError formatted when a schema has not the expected prefix