[shrinkwrap-issues] [JBoss JIRA] Commented: (SHRINKDESC-45) Import XML to generic Node structure should be public API

[Lincoln Baxter III (JIRA)]

    [ https://issues.jboss.org/browse/SHRINKDESC-45?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12591531#comment-12591531 ] 

Lincoln Baxter III commented on SHRINKDESC-45:
----------------------------------------------

Actually. This is as simple as pulling up the Node import from XMLImporter:

{code}/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.seam.forge.parser.xml;

import java.io.ByteArrayInputStream;
import java.io.InputStream;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.jboss.shrinkwrap.descriptor.api.DescriptorImportException;
import org.jboss.shrinkwrap.descriptor.api.Node;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.NodeList;

/**
 * @author <a href="mailto:lincolnbaxter at gmail.com">Lincoln Baxter, III</a>
 * @author <a href="mailto:aslak at redhat.com">Aslak Knutsen</a>
 * 
 */
public class XMLParser
{
   public static Node parse(byte[] xml)
   {
      return parse(new ByteArrayInputStream(xml));
   }

   public static Node parse(String xml)
   {
      return parse(xml.getBytes());
   }

   public static Node parse(InputStream stream) throws DescriptorImportException
   {
      try
      {
         if (stream.available() == 0)
         {
            return null;
         }

         DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
         factory.setNamespaceAware(true);
         DocumentBuilder builder = factory.newDocumentBuilder();
         Document doc = builder.parse(stream);

         Node root = new Node(doc.getDocumentElement().getNodeName());
         readRecursive(root, doc.getDocumentElement());
         return root;

      }
      catch (Exception e)
      {
         throw new DescriptorImportException("Could not import XML from stream", e);
      }
   }

   private static void readRecursive(Node target, org.w3c.dom.Node source)
   {
      readAttributes(target, source);
      NodeList sourceChildren = source.getChildNodes();
      if (sourceChildren != null)
      {
         for (int i = 0; i < sourceChildren.getLength(); i++)
         {
            org.w3c.dom.Node child = sourceChildren.item(i);
            if (child.getNodeType() != org.w3c.dom.Node.TEXT_NODE)
            {
               Node newTarget = target.create(child.getNodeName());
               if (onlyTextChildren(child))
               {
                  newTarget.text(child.getTextContent());
                  readAttributes(newTarget, child);
               }
               else
               {
                  readRecursive(newTarget, child);
               }
            }
         }
      }
   }

   private static void readAttributes(Node target, org.w3c.dom.Node source)
   {
      NamedNodeMap attributes = source.getAttributes();
      if (attributes != null)
      {
         for (int i = 0; i < attributes.getLength(); i++)
         {
            org.w3c.dom.Node attribute = attributes.item(i);
            target.attribute(attribute.getNodeName(), attribute.getNodeValue());
         }
      }
   }

   private static boolean onlyTextChildren(org.w3c.dom.Node source)
   {
      NodeList children = source.getChildNodes();
      for (int i = 0; i < children.getLength(); i++)
      {
         org.w3c.dom.Node child = children.item(i);
         if (child.getNodeType() != org.w3c.dom.Node.TEXT_NODE)
         {
            return false;
         }
      }
      return true;
   }
}{code}

> Import XML to generic Node structure should be public API
> ---------------------------------------------------------
>
>                 Key: SHRINKDESC-45
>                 URL: https://issues.jboss.org/browse/SHRINKDESC-45
>             Project: ShrinkWrap Descriptors
>          Issue Type: Feature Request
>          Components: api
>    Affects Versions: 0.1.5
>            Reporter: Lincoln Baxter III
>
> XMLImporter should probably be public, and provide a few convenience methods to build an ad-hoc Node graph.
> XMLImporter.asNodes(InputStream stream);
> XMLImporter.asNodes(String xml);
> XMLImporter.asNodes(byte[] xml);
> This would make Descriptors useful as a pure XML manipulation library, and provide a nice path to entry for new users. A nice appealing feature to get people to use it in their projects.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira