com.itextpdf.pdfua.checkers.utils.PdfUAValidationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfua-android Show documentation
The newest version!
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2024 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.pdfua.checkers.utils;

import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.tagging.IStructureNode;
import com.itextpdf.kernel.pdf.tagging.PdfStructElem;
import com.itextpdf.kernel.pdf.tagutils.IRoleMappingResolver;

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

    private final PdfDocument pdfDocument;

    /**
     * Creates a new instance of {@link PdfUAValidationContext}.
     *
     * @param pdfDocument The pdfDocument where the validation is happening.
     */
    public PdfUAValidationContext(PdfDocument pdfDocument) {
        this.pdfDocument = pdfDocument;
    }

    /**
     * Resolves the node's role to a standard role.
     *
     * @param node The node you want to resolve the standard role for.
     *
     * @return The role.
     */
    public String resolveToStandardRole(IStructureNode node) {
        if (node == null) {
            return null;
        }
        PdfName originalRole = node.getRole();
        if (originalRole == null) {
            return null;
        }

        return resolveToStandardRole(originalRole.getValue());
    }

    /**
     * Resolves the  role to a standard role
     *
     * @param role The role you want to resolve the standard role for.
     *
     * @return The role.
     */
    public String resolveToStandardRole(String role) {
        if (role == null) {
            return null;
        }
        IRoleMappingResolver resolver = pdfDocument.getTagStructureContext()
                .resolveMappingToStandardOrDomainSpecificRole(role, null);
        if (resolver == null) {
            return role;
        }
        return resolver.getRole();
    }

    /**
     * Checks if a {@link 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.
     *
     * @param role          The role we want to check against.
     * @param structureNode The structure node we want to check.
     *
     * @return The {@link PdfStructElem} if the role matches.
     */
    public PdfStructElem getElementIfRoleMatches(PdfName role, IStructureNode structureNode) {
        if (structureNode == null) {
            return null;
        }
        if (!(structureNode instanceof PdfStructElem)) {
            return null;
        }
        //We can get away with the short code without resolving it. Because we have checks in place
        //that would catch remapped standard roles and cyclic roles.
        if (role.equals(structureNode.getRole()) || role.getValue().equals(resolveToStandardRole(structureNode))) {
            return (PdfStructElem) structureNode;
        }
        return null;
    }
}