package org.theonefx.wcframework.utils;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.CharacterData;
import org.w3c.dom.Comment;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.EntityReference;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
public abstract class DocumentUtils {
/**
* @Method : isTextElement
* @Author : TheoneFx
* @Date : 2011-7-20
* @Version : 1.0
* @Description : 判断一个xml节点是否是一个纯的text节点
*/
public static boolean isTextElement(Element element){
Assert.notNull(element);
return (element.getChildNodes().getLength()==1 && element.getFirstChild().getNodeType() == Element.TEXT_NODE);
}
/**
* @Method : getFirstSubElementIgnoreText
* @author : 陈曦
* @date : 2012-2-5 下午04:23:04
* @Description : 获得第一个非text节点的子节点
*/
public static Element getFirstSubElementIgnoreText(Element element){
Assert.notNull(element);
for(int i=0;i<element.getChildNodes().getLength();i++){
if(element.getChildNodes().item(i).getNodeType() == Element.ELEMENT_NODE){
return (Element) element.getChildNodes().item(i);
}
}
return null;
}
/**
* Retrieve all child elements of the given DOM element that match any of the given element names. Only look at the
* direct child level of the given element; do not go into further depth (in contrast to the DOM API's
* <code>getElementsByTagName</code> method).
*
* @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
* @see org.w3c.dom.Element#getElementsByTagName
*/
public static List<Element> getChildElementsByTagName(Element ele, String[] childEleNames) {
Assert.notNull(ele, "Element must not be null");
Assert.notNull(childEleNames, "Element names collection must not be null");
List<String> childEleNameList = Arrays.asList(childEleNames);
NodeList nl = ele.getChildNodes();
List<Element> childEles = new ArrayList<Element>();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element && nodeNameMatch(node, childEleNameList)) {
childEles.add((Element) node);
}
}
return childEles;
}
/**
* Retrieve all child elements of the given DOM element that match the given element name. Only look at the direct
* child level of the given element; do not go into further depth (in contrast to the DOM API's
* <code>getElementsByTagName</code> method).
*
* @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});
}
/**
* Utility method that returns the first child element identified by its name.
*
* @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, or <code>null</code> if none found
*/
public static Element getFirstChildElementByTagName(Element ele, String childEleName) {
Assert.notNull(ele, "Element must not be null");
Assert.notNull(childEleName, "Element name must not be null");
NodeList nl = ele.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element && nodeNameMatch(node, childEleName)) {
return (Element) node;
}
}
return null;
}
/**
* Utility method that returns the first child element value identified by its name.
*
* @param ele the DOM element to analyze
* @param childEleName the child element name to look for
* @return the extracted text value, or <code>null</code> if no child element found
*/
public static String getFirstChildElementValueByTagName(Element ele, String childEleName) {
Element child = getFirstChildElementByTagName(ele, childEleName);
return (child != null ? getTextValue(child) : null);
}
/**
* Retrieve all child elements of the given DOM element
* @param ele the DOM element to analyze
* @return a List of child <code>org.w3c.dom.Element</code> instances
*/
public static List<Element> getChildElements(Element ele) {
Assert.notNull(ele, "Element must not be null");
NodeList nl = ele.getChildNodes();
List<Element> childEles = new ArrayList<Element>();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
childEles.add((Element) node);
}
}
return childEles;
}
/**
* Extract the text value from the given DOM element, ignoring XML comments. <p>Appends all CharacterData nodes and
* EntityReference nodes into a single String value, excluding Comment nodes.
*
* @see CharacterData
* @see EntityReference
* @see Comment
*/
public static String getTextValue(Element valueEle) {
Assert.notNull(valueEle, "Element must not be null");
StringBuilder sb = new StringBuilder();
NodeList nl = valueEle.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node item = nl.item(i);
if ((item instanceof CharacterData && !(item instanceof Comment)) || item instanceof EntityReference) {
sb.append(item.getNodeValue());
}
}
return sb.toString();
}
/**
* Namespace-aware equals comparison. Returns <code>true</code> if either {@link Node#getLocalName} or {@link
* Node#getNodeName} equals <code>desiredName</code>, otherwise returns <code>false</code>.
*/
public static boolean nodeNameEquals(Node node, String desiredName) {
Assert.notNull(node, "Node must not be null");
Assert.notNull(desiredName, "Desired name must not be null");
return nodeNameMatch(node, desiredName);
}
/** 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. */
private static boolean nodeNameMatch(Node node, Collection<?> desiredNames) {
return (desiredNames.contains(node.getNodeName()) || desiredNames.contains(node.getLocalName()));
}
public static Document getDocument(InputStream is) throws SAXException, IOException, ParserConfigurationException{
Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(is);
return document;
}
}