org.verapdf.pdfa.validation.profiles

Interface ValidationProfile

public interface ValidationProfile

veraPDF ValidationProfiles encapsulate the validation rules and tests that are enforced by the PDF/A Validator. A validation profile is associated with a particular PDFAFlavour, that identifies the specific PDF/A specification and conformance level that it is designed to test.

Author:

Carl Wilson

Method Summary

Modifier and Type	Method and Description
ProfileDetails	getDetails()
String	getHexSha1Digest()
PDFAFlavour	getPDFAFlavour()
Rule	getRuleByRuleId(RuleId id)
Set<Rule>	getRules()
Set<Rule>	getRulesByObject(String objectName) Retrieve the complete Set of validation Rules associated with a PDF object
Set<Variable>	getVariables() TODO: A better explanation of Variables and their role.
Set<Variable>	getVariablesByObject(String objectName) TODO: A better explanation of Variables and their role.

Method Detail

getPDFAFlavour

PDFAFlavour getPDFAFlavour()

Returns:

the PDFAFlavour that identifies the specification part and conformance level tested by this profile.

getDetails

ProfileDetails getDetails()

Returns:

the ProfileDetails for this profile.

getHexSha1Digest

String getHexSha1Digest()

Returns:

a hex-encoded String representation of the SHA-1 digest of this ValidationProfile

getRules

Set<Rule> getRules()

Returns:

the full set of Validation Rules that are enforce by this ValidationProfile

getRuleByRuleId

Rule getRuleByRuleId(RuleId id)

Parameters:

id - the RuleId of the Rule to be retrieved.

Returns:

the Rule associated with this id

getRulesByObject

Set<Rule> getRulesByObject(String objectName)

Retrieve the complete Set of validation Rules associated with a PDF object

Parameters:

objectName - the String name identifier for the object

Returns:

the full set of Validation Rules that are associated with object name

getVariables

Set<Variable> getVariables()

TODO: A better explanation of Variables and their role.

Returns:

the full set of Variables used by this ValidationProfile.

getVariablesByObject

Set<Variable> getVariablesByObject(String objectName)

TODO: A better explanation of Variables and their role.

Parameters:

objectName -

Returns:

the full set of Variables that are associated with object name.