com.googlecode.jinahya.xml.KDOMElementLocator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Jin Kwon.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.googlecode.jinahya.xml;


import java.util.Iterator;
import java.util.Map;

import org.kxml2.kdom.Document;
import org.kxml2.kdom.Element;
import org.kxml2.kdom.Node;


/**
 * A kXML2 implementation.
 *
 * @author Jin Kwon
 * @see kXML2
 */
public class KDOMElementLocator extends ElementLocator {


    /**
     * Parses given document and creates a new ElementLocator
     * instance.
     *
     * @param document document to parse
     * @return a new ElementLocator instance.
     */
    public static ElementLocator parse(final Document document) {

        if (document == null) {
            throw new NullPointerException("null document");
        }

        final Element rootElement = document.getRootElement();
        if (rootElement == null) {
            throw new IllegalArgumentException("no root element");
        }

        return new KDOMElementLocator(parse(rootElement));
    }


    /**
     * Parses given element.
     *
     * @param element element to parse
     * @return a new ELElement
     */
    private static ELElement parse(final Element element) {

        if (element == null) {
            throw new NullPointerException("null element");
        }

        String namespaceURI = element.getNamespace();
        if (namespaceURI == null) {
            namespaceURI = ELNode.NULL_NS_URI;
        }
        final String localName = element.getName();

        final ELElement elelement = new ELElement(namespaceURI, localName);

        final int attributeCount = element.getAttributeCount();
        for (int i = 0; i < attributeCount; i++) {
            String attributeNamespaceURI = element.getAttributeNamespace(i);
            if (ELNode.XMLNS_ATTRIBUTE_NS_URI.equals(attributeNamespaceURI)) {
                continue;
            }
            if (attributeNamespaceURI == null) {
                attributeNamespaceURI = ELNode.NULL_NS_URI;
            }
            final String attributeLocalName = element.getAttributeName(i);
            final String attributeValue = element.getAttributeValue(i);
            elelement.getAttributes().put(
                ELNode.jamesClark(attributeNamespaceURI, attributeLocalName),
                new ELAttribute(attributeNamespaceURI, attributeLocalName,
                                attributeValue));
        }

        String text = null;

        final int childCount = element.getChildCount();
        for (int i = 0; i < childCount; i++) {
            switch (element.getType(i)) {
                case Node.CDSECT:
                case Node.TEXT:
                    if (text == null) {
                        text = element.getText(i);
                    }
                    break;
                case Node.ELEMENT:
                    elelement.getElements().add(
                        parse((Element) element.getChild(i)));
                    break;
                default:
                    break;
            }
        }

        if (elelement.getElements().isEmpty()) {
            elelement.setText(text);
        }

        return elelement;
    }


    /**
     * Prints given element to a new Document.
     *
     * @param locator element to print
     * @return a new document to which element has been printed.
     */
    public static Document print(final ElementLocator locator) {

        if (locator == null) {
            throw new NullPointerException("null locator");
        }

        final Document document = new Document();

        print(locator, document);

        return document;
    }


    /**
     * Prints given locator to specified document.
     *
     * @param locator the element to print
     * @param document the document to which element is printed.
     */
    public static void print(final ElementLocator locator,
                             final Document document) {

        if (locator == null) {
            throw new NullPointerException("null locator");
        }

        if (document == null) {
            throw new NullPointerException("null document");
        }

        final ELElement root = locator.getRoot();
        print(root, document, getNamespaces(root));
    }


    /**
     * Appends given child to specified parent.
     *
     * @param child child
     * @param parent parent
     * @param namesapces namespaces
     */
    private static void print(final ELElement child, final Node parent,
                              final Map namesapces) {

        if (child == null) {
            throw new NullPointerException("null child");
        }

        if (parent == null) {
            throw new NullPointerException("null parent");
        }

        if (namesapces == null) {
            throw new NullPointerException("null namespaces");
        }

        final int childCount = parent.getChildCount();
        for (int i = childCount - 1; i >= 0; i--) {
            parent.removeChild(i);
        }

        final Element element = parent.createElement(
            child.getNamespaceURI(), child.getLocalName());
        parent.addChild(Node.ELEMENT, element);

        for (Iterator i = child.getAttributes().values().iterator();
             i.hasNext();) {
            final ELAttribute attribute = (ELAttribute) i.next();
            element.setAttribute(attribute.getNamespaceURI(),
                                 attribute.getLocalName(),
                                 attribute.getValue());
        }

        if (!child.getElements().isEmpty()) {
            for (Iterator i = child.getElements().iterator(); i.hasNext();) {
                print((ELElement) i.next(), element, namesapces);
            }
            return;
        }

        if (child.getText() != null) {
            element.addChild(Node.TEXT, child.getText());
        }
    }


    /**
     * Creates a new instance.
     *
     * @param root root element
     */
    public KDOMElementLocator(final ELElement root) {
        super(root);
    }
}