org.mycore.common.xml.MCRXPathBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.common.xml;

import org.jdom2.Attribute;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.Namespace;
import org.jdom2.Parent;
import org.mycore.common.MCRConstants;

/**
 * Builds an absolute XPath expression for a given element or attribute within a JDOM XML structure.
 *
 * @author Frank L\u00FCtzenkirchen
 */
public class MCRXPathBuilder {

    /**
     * Builds an absolute XPath expression for a given element or attribute within a JDOM XML structure.
     * In case any ancestor element in context is not the first one, the XPath will also contain a position predicate.
     * For all namespaces commonly used in MyCoRe, their namespace prefixes will be used.
     *
     * @param object a JDOM element or attribute
     * @return absolute XPath of that object. In case there is a root Document, it will begin with a "/".
     */
    public static String buildXPath(Object object) {
        if (object instanceof Element) {
            return buildXPath((Element) object);
        } else if (object instanceof Attribute) {
            return buildXPath((Attribute) object);
        } else {
            return "";
        }
    }

    /**
     * Builds an absolute XPath expression for the given attribute within a JDOM XML structure.
     * In case any ancestor element in context is not the first one, the XPath will also contain position predicates.
     * For all namespaces commonly used in MyCoRe, their namespace prefixes will be used.
     *
     * @param attribute a JDOM attribute
     * @return absolute XPath of that attribute. In case there is a root Document, it will begin with a "/".
     */
    public static String buildXPath(Attribute attribute) {
        String parentXPath = buildXPath(attribute.getParent());
        if (!parentXPath.isEmpty()) {
            parentXPath += "/";
        }
        return parentXPath + "@" + attribute.getQualifiedName();
    }

    /**
     * Builds an absolute XPath expression for the given element within a JDOM XML structure.
     * In case any ancestor element in context is not the first one, the XPath will also contain position predicates.
     * For all namespaces commonly used in MyCoRe, their namespace prefixes will be used.
     *
     * @param element a JDOM element
     * @return absolute XPath of that element. In case there is a root Document, it will begin with a "/".
     */
    public static String buildXPath(Element element) {
        if (element == null) {
            return "";
        }

        String parentXPath = buildXPath(element.getParent());
        if ((!parentXPath.isEmpty()) || (element.getParent() instanceof Document)) {
            parentXPath += "/";
        }
        return parentXPath + buildChildPath(element);
    }

    /**
     * Builds a local XPath fragment as combined namespace prefix, local element name and position predicate
     */
    public static String buildChildPath(Element element) {
        return getNamespacePrefix(element) + element.getName() + buildPositionPredicate(element);
    }

    /**
     * Returns the namespace prefix for this element, followed by a ":",
     * or the empty string if no namespace prefix known.
     */
    public static String getNamespacePrefix(Element element) {
        Namespace nsElement = element.getNamespace();
        for (Namespace ns : MCRConstants.getStandardNamespaces()) {
            if (ns.equals(nsElement)) {
                return ns.getPrefix() + ":";
            }
        }

        String prefix = nsElement.getPrefix();
        if ((prefix != null) && !prefix.isEmpty()) {
            return prefix + ":";
        } else {
            return "";
        }
    }

    private static String buildPositionPredicate(Element element) {
        Parent parent = element.getParent();
        if ((parent instanceof Document) || (parent == null)) {
            return "";
        }

        Element parentElement = (Element) parent;
        int pos = parentElement.getChildren(element.getName(), element.getNamespace()).indexOf(element);
        return (pos == 0 ? "" : "[" + ++pos + "]");
    }
}