Added DomContentHandler

org.springframework.core/src/main/java/org/springframework/util/xml/DomContentHandler.java

@@ -0,0 +1,137 @@
+/*
+ * Copyright 2002-2009 the original author or authors.
+ *
+ * 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 org.springframework.util.xml;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.ProcessingInstruction;
+import org.w3c.dom.Text;
+import org.xml.sax.Attributes;
+import org.xml.sax.ContentHandler;
+import org.xml.sax.Locator;
+import org.xml.sax.SAXException;
+
+import org.springframework.util.Assert;
+
+/**
+ * SAX <code>ContentHandler</code> that transforms callback calls to DOM <code>Node</code>s.
+ *
+ * @author Arjen Poutsma
+ * @see org.w3c.dom.Node
+ * @since 3.0
+ */
+class DomContentHandler implements ContentHandler {
+
+	private final Document document;
+
+	private final List<Element> elements = new ArrayList<Element>();
+
+	private final Node node;
+
+	/**
+	 * Creates a new instance of the <code>DomContentHandler</code> with the given node.
+	 *
+	 * @param node the node to publish events to
+	 */
+	DomContentHandler(Node node) {
+		Assert.notNull(node, "node must not be null");
+		this.node = node;
+		if (node instanceof Document) {
+			document = (Document) node;
+		}
+		else {
+			document = node.getOwnerDocument();
+		}
+		Assert.notNull(document, "document must not be null");
+	}
+
+	private Node getParent() {
+		if (!elements.isEmpty()) {
+			return elements.get(elements.size() - 1);
+		}
+		else {
+			return node;
+		}
+	}
+
+	public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
+		Node parent = getParent();
+		Element element = document.createElementNS(uri, qName);
+		for (int i = 0; i < attributes.getLength(); i++) {
+			String attrUri = attributes.getURI(i);
+			String attrQname = attributes.getQName(i);
+			String value = attributes.getValue(i);
+			if (!attrQname.startsWith("xmlns")) {
+				element.setAttributeNS(attrUri, attrQname, value);
+			}
+		}
+		element = (Element) parent.appendChild(element);
+		elements.add(element);
+	}
+
+	public void endElement(String uri, String localName, String qName) throws SAXException {
+		elements.remove(elements.size() - 1);
+	}
+
+	public void characters(char ch[], int start, int length) throws SAXException {
+		String data = new String(ch, start, length);
+		Node parent = getParent();
+		Node lastChild = parent.getLastChild();
+		if (lastChild != null && lastChild.getNodeType() == Node.TEXT_NODE) {
+			((Text) lastChild).appendData(data);
+		}
+		else {
+			Text text = document.createTextNode(data);
+			parent.appendChild(text);
+		}
+	}
+
+	public void processingInstruction(String target, String data) throws SAXException {
+		Node parent = getParent();
+		ProcessingInstruction pi = document.createProcessingInstruction(target, data);
+		parent.appendChild(pi);
+	}
+
+	/*
+		 * Unsupported
+		 */
+
+	public void setDocumentLocator(Locator locator) {
+	}
+
+	public void startDocument() throws SAXException {
+	}
+
+	public void endDocument() throws SAXException {
+	}
+
+	public void startPrefixMapping(String prefix, String uri) throws SAXException {
+	}
+
+	public void endPrefixMapping(String prefix) throws SAXException {
+	}
+
+	public void ignorableWhitespace(char ch[], int start, int length) throws SAXException {
+	}
+
+	public void skippedEntity(String name) throws SAXException {
+	}
+}

org.springframework.core/src/main/java/org/springframework/util/xml/DomUtils.java

@@ -27,28 +27,28 @@ import org.w3c.dom.Element;
 import org.w3c.dom.EntityReference;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
+import org.xml.sax.ContentHandler;
 
 import org.springframework.util.Assert;
 
 /**
- * Convenience methods for working with the DOM API,
+ * Convenience methods for working with the DOM API, in particular for working with DOM Nodes and DOM Elements.
- * in particular for working with DOM Nodes and DOM Elements.
  *
  * @author Juergen Hoeller
  * @author Rob Harrop
  * @author Costin Leau
- * @since 1.2
  * @see org.w3c.dom.Node
  * @see org.w3c.dom.Element
+ * @since 1.2
  */
 public abstract class DomUtils {
 
 	/**
-	 * Retrieve all child elements of the given DOM element that match any of
+	 * Retrieve all child elements of the given DOM element that match any of the given element names. Only look at the
-	 * the given element names. Only look at the direct child level of the
+	 * direct child level of the given element; do not go into further depth (in contrast to the DOM API's
-	 * given element; do not go into further depth (in contrast to the
+	 * <code>getElementsByTagName</code> method).
-	 * DOM API's <code>getElementsByTagName</code> method).
+	 *
-	 * @param ele the DOM element to analyze
+	 * @param ele		   the DOM element to analyze
 	 * @param childEleNames the child element names to look for
 	 * @return a List of child <code>org.w3c.dom.Element</code> instances
 	 * @see org.w3c.dom.Element
@@ -70,27 +70,26 @@ public abstract class DomUtils {
 	}
 
 	/**
-	 * Retrieve all child elements of the given DOM element that match
+	 * Retrieve all child elements of the given DOM element that match the given element name. Only look at the direct
-	 * the given element name. Only look at the direct child level of the
+	 * child level of the given element; do not go into further depth (in contrast to the DOM API's
-	 * given element; do not go into further depth (in contrast to the
+	 * <code>getElementsByTagName</code> method).
-	 * DOM API's <code>getElementsByTagName</code> method).
+	 *
-	 * @param ele the DOM element to analyze
+	 * @param ele		  the DOM element to analyze
 	 * @param childEleName the child element name to look for
 	 * @return a List of child <code>org.w3c.dom.Element</code> instances
 	 * @see org.w3c.dom.Element
 	 * @see org.w3c.dom.Element#getElementsByTagName
 	 */
 	public static List<Element> getChildElementsByTagName(Element ele, String childEleName) {
-		return getChildElementsByTagName(ele, new String[] {childEleName});
+		return getChildElementsByTagName(ele, new String[]{childEleName});
 	}
 
 	/**
-	 * Utility method that returns the first child element
+	 * Utility method that returns the first child element identified by its name.
-	 * identified by its name.
+	 *
-	 * @param ele the DOM element to analyze
+	 * @param ele		  the DOM element to analyze
 	 * @param childEleName the child element name to look for
-	 * @return the <code>org.w3c.dom.Element</code> instance,
+	 * @return the <code>org.w3c.dom.Element</code> instance, or <code>null</code> if none found
-	 * or <code>null</code> if none found
 	 */
 	public static Element getChildElementByTagName(Element ele, String childEleName) {
 		Assert.notNull(ele, "Element must not be null");
@@ -106,12 +105,11 @@ public abstract class DomUtils {
 	}
 
 	/**
-	 * Utility method that returns the first child element value
+	 * Utility method that returns the first child element value identified by its name.
-	 * identified by its name.
+	 *
-	 * @param ele the DOM element to analyze
+	 * @param ele		  the DOM element to analyze
 	 * @param childEleName the child element name to look for
-	 * @return the extracted text value,
+	 * @return the extracted text value, or <code>null</code> if no child element found
-	 * or <code>null</code> if no child element found
 	 */
 	public static String getChildElementValueByTagName(Element ele, String childEleName) {
 		Element child = getChildElementByTagName(ele, childEleName);
@@ -119,9 +117,9 @@ public abstract class DomUtils {
 	}
 
 	/**
-	 * Extract the text value from the given DOM element, ignoring XML comments.
+	 * Extract the text value from the given DOM element, ignoring XML comments. <p>Appends all CharacterData nodes and
-	 * <p>Appends all CharacterData nodes and EntityReference nodes
+	 * EntityReference nodes into a single String value, excluding Comment nodes.
-	 * into a single String value, excluding Comment nodes.
+	 *
 	 * @see CharacterData
 	 * @see EntityReference
 	 * @see Comment
@@ -140,9 +138,8 @@ public abstract class DomUtils {
 	}
 
 	/**
-	 * Namespace-aware equals comparison. Returns <code>true</code> if either
+	 * Namespace-aware equals comparison. Returns <code>true</code> if either {@link Node#getLocalName} or {@link
-	 * {@link Node#getLocalName} or {@link Node#getNodeName} equals <code>desiredName</code>,
+	 * Node#getNodeName} equals <code>desiredName</code>, otherwise returns <code>false</code>.
-	 * otherwise returns <code>false</code>.
 	 */
 	public static boolean nodeNameEquals(Node node, String desiredName) {
 		Assert.notNull(node, "Node must not be null");
@@ -151,15 +148,21 @@ public abstract class DomUtils {
 	}
 
 	/**
-	 * Matches the given node's name and local name against the given desired name.
+	 * Returns a SAX <code>ContentHandler</code> that transforms callback calls to DOM <code>Node</code>s.
+	 *
+	 * @param node the node to publish events to
+	 * @return the content handler
 	 */
+	public static ContentHandler createContentHandler(Node node) {
+		return new DomContentHandler(node);
+	}
+
+	/** Matches the given node's name and local name against the given desired name. */
 	private static boolean nodeNameMatch(Node node, String desiredName) {
 		return (desiredName.equals(node.getNodeName()) || desiredName.equals(node.getLocalName()));
 	}
 
-	/**
+	/** Matches the given node's name and local name against the given desired names. */
-	 * Matches the given node's name and local name against the given desired names.
-	 */
 	private static boolean nodeNameMatch(Node node, Collection desiredNames) {
 		return (desiredNames.contains(node.getNodeName()) || desiredNames.contains(node.getLocalName()));
 	}

org.springframework.core/src/test/java/org/springframework/util/xml/DomContentHandlerTest.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright 2002-2009 the original author or authors.
+ *
+ * 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 org.springframework.util.xml;
+
+import java.io.StringReader;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+
+import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;
+import org.junit.Before;
+import org.junit.Test;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+public class DomContentHandlerTest {
+
+	private static final String XML_1 =
+			"<?xml version='1.0' encoding='UTF-8'?>" + "<?pi content?>" + "<root xmlns='namespace'>" +
+					"<prefix:child xmlns:prefix='namespace2' xmlns:prefix2='namespace3' prefix2:attr='value'>content</prefix:child>" +
+					"</root>";
+
+	private static final String XML_2_EXPECTED =
+			"<?xml version='1.0' encoding='UTF-8'?>" + "<root xmlns='namespace'>" + "<child xmlns='namespace2' />" +
+					"</root>";
+
+	private static final String XML_2_SNIPPET =
+			"<?xml version='1.0' encoding='UTF-8'?>" + "<child xmlns='namespace2' />";
+
+	private Document expected;
+
+	private DomContentHandler handler;
+
+	private Document result;
+
+	private XMLReader xmlReader;
+
+	private DocumentBuilder documentBuilder;
+
+	@Before
+	public void setUp() throws Exception {
+		DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
+		documentBuilderFactory.setNamespaceAware(true);
+		documentBuilder = documentBuilderFactory.newDocumentBuilder();
+		result = documentBuilder.newDocument();
+		xmlReader = XMLReaderFactory.createXMLReader();
+	}
+
+	@Test
+	public void contentHandlerDocumentNamespacePrefixes() throws Exception {
+		xmlReader.setFeature("http://xml.org/sax/features/namespace-prefixes", true);
+		handler = new DomContentHandler(result);
+		expected = documentBuilder.parse(new InputSource(new StringReader(XML_1)));
+		xmlReader.setContentHandler(handler);
+		xmlReader.parse(new InputSource(new StringReader(XML_1)));
+		assertXMLEqual("Invalid result", expected, result);
+	}
+
+	@Test
+	public void contentHandlerDocumentNoNamespacePrefixes() throws Exception {
+		handler = new DomContentHandler(result);
+		expected = documentBuilder.parse(new InputSource(new StringReader(XML_1)));
+		xmlReader.setContentHandler(handler);
+		xmlReader.parse(new InputSource(new StringReader(XML_1)));
+		assertXMLEqual("Invalid result", expected, result);
+	}
+
+	@Test
+	public void contentHandlerElement() throws Exception {
+		Element rootElement = result.createElementNS("namespace", "root");
+		result.appendChild(rootElement);
+		handler = new DomContentHandler(rootElement);
+		expected = documentBuilder.parse(new InputSource(new StringReader(XML_2_EXPECTED)));
+		xmlReader.setContentHandler(handler);
+		xmlReader.parse(new InputSource(new StringReader(XML_2_SNIPPET)));
+		assertXMLEqual("Invalid result", expected, result);
+
+	}
+}