Apache PDFBox 3.0.4 · org.apache.pdfbox.preflight.annotation.AnnotationValidator

Modifier and Type	Field and Description
protected COSDictionary	annotDictionary COSDictionary of the annotation
private AnnotationValidatorFactory	annotFact
protected PreflightContext	ctx
protected PDAnnotation	pdAnnot Instance of PDAnnotation built using the annotDictionary

Access	Constructor and Description
public	AnnotationValidator(PreflightContext context, COSDictionary annotDictionary)

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: the validation state of the annotations actions. checkActions() Extract a list of ActionManager from the Annotation dictionary and valid them.
protected boolean	Returns: the validation state of the AP content. checkAP() This method checks the AP entry of the Annotation Dictionary.
protected boolean	Returns: true if the CA element is missing or if the value is 1.0. checkCA() Check if the CA value is 1.0.
protected boolean	Returns: true if the C field is present and the RGB profile is used. checkColors() Return true if the C field is present in the Annotation dictionary and if the RGB profile is used in the DestOutputProfile of the OutputIntent dictionary.
protected boolean	Returns: false if a flag is invalid, true otherwise. checkFlags() Checks if flags of the annotation are authorized.
protected boolean	Returns: true if validation succeed, false otherwise. checkMandatoryFields() Checks if all mandatory fields of an annotation are present.
protected boolean	Returns: true if the popup entry is valid, false if not. checkPopup() This method validates the Popup entry.
protected boolean	Returns: the presence of specific fields. checkSpecificMandatoryFields() Override this method to check the presence of specific fields
private COSBase	getFieldType()
protected boolean	Returns: true if a rgb profile is found, false otherwise. searchRGBProfile() Search the RGB Profile in OutputIntents dictionaries
public final void	setFactory(AnnotationValidatorFactory fact) Initialize the annotFact attribute of this object.
public boolean	Returns: true if validation succeed, false otherwise. validate() Execute validation of the Annotation dictionary.

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

annotDictionary	back to summary
protected COSDictionary annotDictionary COSDictionary of the annotation

annotFact	back to summary
private AnnotationValidatorFactory annotFact

ctx	back to summary
protected PreflightContext ctx

pdAnnot	back to summary
protected PDAnnotation pdAnnot Instance of PDAnnotation built using the annotDictionary

AnnotationValidator	back to summary
public AnnotationValidator(PreflightContext context, COSDictionary annotDictionary)

Method Detail

checkActions	back to summary
protected boolean checkActions() throws ValidationException Extract a list of ActionManager from the Annotation dictionary and valid them. If an action is invalid, the errors list is updated and the method returns false. Otherwise, the method returns true and the errors list doesn't change. Returns:boolean the validation state of the annotations actions.

checkActions

back to summary

protected boolean checkActions() throws ValidationException

Extract a list of ActionManager from the Annotation dictionary and valid them. If an action is invalid, the errors list is updated and the method returns false. Otherwise, the method returns true and the errors list doesn't change.

Returns:boolean: the validation state of the annotations actions.

checkAP	back to summary
protected boolean checkAP() throws ValidationException This method checks the AP entry of the Annotation Dictionary. If the AP key is missing, this method returns true. If the AP key exists, only the N entry is authorized and must be a Stream which define the appearance of the annotation. (Currently, only the type of the N entry is checked because of the Appearance stream is a Form XObject, so it will be checked by the Graphics Helper) If the AP content isn't valid, this method return false and updates the errors list. Returns:boolean the validation state of the AP content.

checkAP

back to summary

protected boolean checkAP() throws ValidationException

This method checks the AP entry of the Annotation Dictionary. If the AP key is missing, this method returns true. If the AP key exists, only the N entry is authorized and must be a Stream which define the appearance of the annotation. (Currently, only the type of the N entry is checked because of the Appearance stream is a Form XObject, so it will be checked by the Graphics Helper) If the AP content isn't valid, this method return false and updates the errors list.

Returns:boolean: the validation state of the AP content.

checkCA	back to summary
protected boolean checkCA() Check if the CA value is 1.0. Return true if the CA element is missing or if the value is 1.0. Return false otherwise and update the list of errors present in the DocumentHandler. Returns:boolean true if the CA element is missing or if the value is 1.0.

checkCA

back to summary

protected boolean checkCA()

Check if the CA value is 1.0. Return true if the CA element is missing or if the value is 1.0. Return false otherwise and update the list of errors present in the DocumentHandler.

Returns:boolean: true if the CA element is missing or if the value is 1.0.

checkColors	back to summary
protected boolean checkColors() throws ValidationException Return true if the C field is present in the Annotation dictionary and if the RGB profile is used in the DestOutputProfile of the OutputIntent dictionary. Returns:boolean true if the C field is present and the RGB profile is used.

checkColors

back to summary

protected boolean checkColors() throws ValidationException

Return true if the C field is present in the Annotation dictionary and if the RGB profile is used in the DestOutputProfile of the OutputIntent dictionary.

Returns:boolean: true if the C field is present and the RGB profile is used.

checkFlags	back to summary
protected boolean checkFlags() Checks if flags of the annotation are authorized. Print flag must be 1 NoView flag must be 0 Hidden flag must be 0 Invisible flag must be 0 If one of these flags is invalid, the errors list is updated with the ERROR_ANNOT_FORBIDDEN_FLAG ValidationError code. Returns:boolean false if a flag is invalid, true otherwise.

checkFlags

back to summary

protected boolean checkFlags()

Checks if flags of the annotation are authorized.

Print flag must be 1
NoView flag must be 0
Hidden flag must be 0
Invisible flag must be 0

If one of these flags is invalid, the errors list is updated with the ERROR_ANNOT_FORBIDDEN_FLAG ValidationError code.

Returns:boolean: false if a flag is invalid, true otherwise.

checkMandatoryFields	back to summary
protected boolean checkMandatoryFields() Checks if all mandatory fields of an annotation are present. If some fields are missing, the method returns false and the errors list is updated. Returns:boolean true if validation succeed, false otherwise.

checkMandatoryFields

back to summary

protected boolean checkMandatoryFields()

Checks if all mandatory fields of an annotation are present. If some fields are missing, the method returns false and the errors list is updated.

Returns:boolean: true if validation succeed, false otherwise.

checkPopup	back to summary
protected boolean checkPopup() throws ValidationException This method validates the Popup entry. This entry shall contain an other Annotation. This annotation is validated with the right AnnotationValidator. Returns:boolean true if the popup entry is valid, false if not.

checkPopup

back to summary

protected boolean checkPopup() throws ValidationException

This method validates the Popup entry. This entry shall contain an other Annotation. This annotation is validated with the right AnnotationValidator.

Returns:boolean: true if the popup entry is valid, false if not.

checkSpecificMandatoryFields	back to summary
protected boolean checkSpecificMandatoryFields() Override this method to check the presence of specific fields Returns:boolean the presence of specific fields.

checkSpecificMandatoryFields

back to summary

protected boolean checkSpecificMandatoryFields()

Override this method to check the presence of specific fields

Returns:boolean: the presence of specific fields.

getFieldType	back to summary
private COSBase getFieldType()

searchRGBProfile	back to summary
protected boolean searchRGBProfile() throws ValidationException Search the RGB Profile in OutputIntents dictionaries Returns:boolean true if a rgb profile is found, false otherwise.

searchRGBProfile

back to summary

protected boolean searchRGBProfile() throws ValidationException

Search the RGB Profile in OutputIntents dictionaries

Returns:boolean: true if a rgb profile is found, false otherwise.

setFactory	back to summary
public final void setFactory(AnnotationValidatorFactory fact) Initialize the annotFact attribute of this object. This method must be called by the Factory at the creation of this object. Only the Factory should call this method.

validate	back to summary
public boolean validate() throws ValidationException Execute validation of the Annotation dictionary. Returns:boolean true if validation succeed, false otherwise.

validate

back to summary

public boolean validate() throws ValidationException

Execute validation of the Annotation dictionary.

Returns:boolean: true if validation succeed, false otherwise.

public abstract Class AnnotationValidator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail