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 and Description
PdfUAValidationContext(PdfDocument pdfDocument) Creates a new instance of PdfUAValidationContext.

Method Summary

Modifier and Type	Method and Description
PdfStructElem	getElementIfRoleMatches(PdfName role, IStructureNode structureNode) Checks if a IStructureNode resolved role's is equal to the provided role.
String	resolveToStandardRole(IStructureNode node) Resolves the node's role to a standard role.
String	resolveToStandardRole(String role) 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 Detail

PdfUAValidationContext

public PdfUAValidationContext(PdfDocument pdfDocument)

Creates a new instance of PdfUAValidationContext.

Parameters:

pdfDocument - The pdfDocument where the validation is happening.

Method Detail

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:

The 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.