Package com.itextpdf.pdfua.checkers.utils

Class PdfUAValidationContext

java.lang.Object

com.itextpdf.pdfua.checkers.utils.PdfUAValidationContext

       public class PdfUAValidationContext extends Object
      

This class keeps track of useful information when validating a PdfUaDocument. It also contains some useful utility functions that help with PDF UA validation.

Constructor Summary

Constructors

Constructor	Description
PdfUAValidationContext(PdfDocument pdfDocument)	Creates a new instance of PdfUAValidationContext.

Method Summary

Modifier and Type	Method	Description
PdfObjRef	findObjRefByStructParentIndex(int i, PdfDictionary pageDict)	Retrieves object reference instance by provided structure parent index.
PdfStructElem	getElementIfRoleMatches(PdfName role, IStructureNode structureNode)	Checks if a IStructureNode resolved role's is equal to the provided role.
PdfUAConformance	getUAConformance()	Retrieves the PDF/UA conformance of the PdfDocument.
String	resolveToStandardRole(IStructureNode node)	Resolves the node's role to a standard role.
String	resolveToStandardRole(String role)	Resolves the role to a standard role.
String	resolveToStandardRole(String role, PdfNamespace namespace)	Resolves the role to a standard role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PdfUAValidationContext

             public PdfUAValidationContext
             (PdfDocument pdfDocument)
            

Creates a new instance of PdfUAValidationContext.

Parameters:

pdfDocument - the PdfDocument instance that is being validated

Method Details

resolveToStandardRole

             public String resolveToStandardRole
             (IStructureNode node)
            

Resolves the node's role to a standard role.

Parameters:

node - The node you want to resolve the standard role for.

Returns:

The role.

resolveToStandardRole

             public String resolveToStandardRole
             (String role)
            

Resolves the role to a standard role.

Parameters:

role - the role you want to resolve the standard role for

Returns:

resolved role

resolveToStandardRole

             public String resolveToStandardRole
             (String role, PdfNamespace namespace)
            

Resolves the role to a standard role.

Parameters:

role - the role you want to resolve the standard role for

namespace - namespace where role is defined

Returns:

resolved role

getElementIfRoleMatches

             public PdfStructElem getElementIfRoleMatches
             (PdfName role, IStructureNode structureNode)
            

Checks if a IStructureNode resolved role's is equal to the provided role.

Note: This method will not check recursive mapping. So either the node's role is the provided role, or the standard role is the provided role. So we do not take into account the roles in between the mappings.

Parameters:

role - The role we want to check against.

structureNode - The structure node we want to check.

Returns:

The PdfStructElem if the role matches.

findObjRefByStructParentIndex

             public PdfObjRef findObjRefByStructParentIndex
             (int i, PdfDictionary pageDict)
            

Retrieves object reference instance by provided structure parent index.

Parameters:

i - index of the structure parent

pageDict - PdfDictionary of the page that PdfObjRef belong to

Returns:

PdfObjRef instance

getUAConformance

             public PdfUAConformance getUAConformance()
            

Retrieves the PDF/UA conformance of the PdfDocument.

Returns:

PdfUAConformance value