me.wuwenbin.lang.config.XmlDom4j Maven / Gradle / Ivy
package me.wuwenbin.lang.config;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
/**
* 解析xml,使用方法参考dom4j的使用
*
* @author wuwenbin
* @date 2011/4/13
* @since 1.0
*/
public class XmlDom4j {
/**
* @param xmlPath
* @方法功能描述：生成空的xml文件头
* @方法名:createEmptyXmlFile
* @返回类型：Document
* @时间：2011-4-14下午12:44:20
*/
public Document createEmptyXmlFile(String xmlPath) {
if (xmlPath == null || xmlPath.equals(""))
return null;
XMLWriter output;
Document document = DocumentHelper.createDocument();
OutputFormat format = OutputFormat.createPrettyPrint();
try {
output = new XMLWriter(new FileWriter(xmlPath), format);
output.write(document);
output.close();
} catch (IOException e) {
return null;
}
return document;
}
/**
* 根据xml文件路径取得document对象
*
* @param xmlPath
* @return
* @throws DocumentException
*/
public Document getDocument(String xmlPath) {
if (xmlPath == null || xmlPath.equals(""))
return null;
File file = new File(xmlPath);
if (file.exists() == false) {
return createEmptyXmlFile(xmlPath);
}
SAXReader reader = new SAXReader();
Document document = null;
try {
document = reader.read(xmlPath);
} catch (DocumentException e) {
e.printStackTrace();
}
return document;
}
/**
* @param #document DOC对象
* @方法功能描述：得到根节点
* @方法名:getRootEleme
* @返回类型：Element
* @时间：2011-4-8下午12:54:02
*/
public Element getRootNode(Document document) {
if (document == null)
return null;
Element root = document.getRootElement();
return root;
}
/**
* @param xmlPath
* @return
* @throws DocumentException
* @方法功能描述: 根据路径直接拿到根节点
* @方法名:getRootElement
* @参数描述 :
* @返回类型：Element
* @时间：2011-4-14下午03:01:14
*/
public Element getRootNode(String xmlPath) {
if (xmlPath == null || (xmlPath.trim()).equals(""))
return null;
Document document = getDocument(xmlPath);
if (document == null)
return null;
return getRootNode(document);
}
/**
* @param parent
* @方法功能描述:得到指定元素的迭代器
* @方法名:getIterator
* @返回类型：Iterator
* @时间：2011-4-14上午11:29:18
*/
@SuppressWarnings("unchecked")
public Iterator getIterator(Element parent) {
if (parent == null)
return null;
Iterator iterator = parent.elementIterator();
return iterator;
}
/**
* @param parent
* @param childName
* @方法功能描述: 根据子节点名称得到指定的子节点
* @方法名:getChildElement
* @返回类型：Element
* @时间：2011-4-14上午11:18:03
*/
@SuppressWarnings("unchecked")
public List getChildElements(Element parent, String childName) {
childName = childName.trim();
if (parent == null)
return null;
childName += "//";
List childElements = parent.selectNodes(childName);
return childElements;
}
/**
* @param node
* @return @参数描述 :
* @方法功能描述：TODO
* @方法名:getChildList
* @返回类型：List
* @时间：2011-4-14下午12:21:52
*/
public List getChildList(Element node) {
if (node == null)
return null;
Iterator itr = getIterator(node);
if (itr == null)
return null;
List childList = new ArrayList();
while (itr.hasNext()) {
Element kidElement = itr.next();
if (kidElement != null) {
childList.add(kidElement);
}
}
return childList;
}
/**
* @param parent
* @param nodeNodeName
* @return @参数描述 : 父节点，子节点名称
* @方法功能描述 : 查询没有子节点的节点，使用xpath方式
* @方法名:getSingleNode
* @返回类型：Node
* @时间：2011-4-14下午12:38:25
*/
public Node getSingleNode(Element parent, String nodeNodeName) {
nodeNodeName = nodeNodeName.trim();
String xpath = "//";
if (parent == null)
return null;
if (nodeNodeName == null || nodeNodeName.equals(""))
return null;
xpath += nodeNodeName;
Node kid = parent.selectSingleNode(xpath);
return kid;
}
/**
* @param parent
* @param childName
* @return @参数描述 :
* @方法功能描述：得到子节点，不使用xpath
* @方法名:getChild
* @返回类型：Element
* @时间：2011-4-14下午12:53:22
*/
@SuppressWarnings("rawtypes")
public Element getChild(Element parent, String childName) {
childName = childName.trim();
if (parent == null)
return null;
if (childName == null || childName.equals(""))
return null;
Element e = null;
Iterator it = getIterator(parent);
while (it != null && it.hasNext()) {
Element k = (Element) it.next();
if (k == null)
continue;
if (k.getName().equalsIgnoreCase(childName)) {
e = k;
break;
}
}
return e;
}
/**
* @param e
* @方法功能描述：判断节点是否还有子节点
* @方法名:hasChild
* @返回类型：boolean
* @时间：2011-4-14下午01:43:48
*/
public boolean hasChild(Element e) {
if (e == null)
return false;
return e.hasContent();
}
/**
* @param e
* @方法功能描述：得到指定节点的属性的迭代器
* @方法名:getAttrIterator
* @返回类型：Iterator
* @时间：2011-4-14下午01:42:38
*/
@SuppressWarnings("unchecked")
public Iterator getAttrIterator(Element e) {
if (e == null)
return null;
Iterator attrIterator = e.attributeIterator();
return attrIterator;
}
/**
* @param e
* @return 节点属性的list集合
* @方法功能描述：遍历指定节点的所有属性
* @方法名:getAttributeList
* @返回类型：List
* @时间：2011-4-14下午01:41:38
*/
public List getAttributeList(Element e) {
if (e == null)
return null;
List attributeList = new ArrayList();
Iterator atrIterator = getAttrIterator(e);
if (atrIterator == null)
return null;
while (atrIterator.hasNext()) {
Attribute attribute = atrIterator.next();
attributeList.add(attribute);
}
return attributeList;
}
/**
* @param element 指定的元素
* @param attrName 属性名称
* @return Attribute
* @方法功能描述： 得到指定节点的指定属性
* @方法名:getAttribute
* @返回类型：Attribute
* @时间：2011-4-14下午01:45:27
*/
public Attribute getAttribute(Element element, String attrName) {
attrName = attrName.trim();
if (element == null)
return null;
if (attrName == null || attrName.equals(""))
return null;
Attribute attribute = element.attribute(attrName);
return attribute;
}
/**
* @param e
* @param attrName
* @方法功能描述:获取指定节点指定属性的值
* @方法名:attrValue
* @返回类型：String
* @时间：2011-4-14下午02:36:48
*/
public String attrValue(Element e, String attrName) {
attrName = attrName.trim();
if (e == null)
return null;
if (attrName == null || attrName.equals(""))
return null;
return e.attributeValue(attrName);
}
/**
* @return 属性集合
* @方法功能描述：得到指定节点的所有属性及属性值
* @方法名:getNodeAttrMap
* @返回类型：Map
* @时间：2011-4-15上午10:00:26
*/
public Map getNodeAttrMap(Element e) {
Map attrMap = new HashMap();
if (e == null) {
return null;
}
List attributes = getAttributeList(e);
if (attributes == null) {
return null;
}
for (Attribute attribute : attributes) {
String attrValueString = attrValue(e, attribute.getName());
attrMap.put(attribute.getName(), attrValueString);
}
return attrMap;
}
/**
* @param e
* @return @参数描述 :
* @方法功能描述: 遍历指定节点的下没有子节点的元素的text值
* @方法名:getSingleNodeText
* @返回类型：Map
* @时间：2011-4-15下午12:24:38
*/
public Map getSingleNodeText(Element e) {
Map map = new HashMap();
if (e == null)
return null;
List kids = getChildList(e);
for (Element e2 : kids) {
if (e2.getTextTrim() != null) {
map.put(e2.getName(), e2.getTextTrim());
}
}
return map;
}
/**
* @param xmlFilePath
* @return @参数描述 :
* @方法功能描述：遍历根节点下，没有子节点的元素节点，并将此节点的text值放入map中返回
* @方法名:getSingleNodeText
* @返回类型：Map
* @时间：2011-4-15下午12:23:30
*/
public Map getSingleNodeText(String xmlFilePath) {
xmlFilePath = xmlFilePath.trim();
if (xmlFilePath == null || xmlFilePath.equals("")) {
return null;
}
Element rootElement = getRootNode(xmlFilePath);
if (rootElement == null || !hasChild(rootElement)) {
return null;
}
return getSingleNodeText(rootElement);
}
public enum Flag {
one, more
}
/**
* @param xmlFilePath
* @param tagName
* @param flag : 指定元素的个数
* @方法功能描述:根据xml路径和指定的节点的名称，得到指定节点,从根节点开始找
* @方法名:getNameNode
* @返回类型：Element 指定的节点
* @时间：2011-4-15下午12:22:35
*/
@SuppressWarnings("unchecked")
public T getNameNode(String xmlFilePath, String tagName, Flag flag) {
xmlFilePath = xmlFilePath.trim();
tagName = tagName.trim();
if (xmlFilePath == null || tagName == null || xmlFilePath.equals("") || tagName.equals(""))
return null;
Element rootElement = getRootNode(xmlFilePath);
if (rootElement == null)
return null;
List tagElementList = getNameElement(rootElement, tagName);
if (tagElementList == null)
return null;
switch (flag) {
case one:
return (T) tagElementList.get(0);
default:
break;
}
return (T) tagElementList;
}
/**
* @param e
* @return @参数描述 :
* @方法功能描述:得到指定节点下所有子节点的属性集合
* @方法名:getNameNodeAllAttributeMap
* @返回类型：Map
* @时间：2011-4-18下午04:40:14
*/
public Map getNameNodeAllKidsAttributeMap(Element parent) {
Map allAttrMap = new HashMap();
if (parent == null)
return null;
List childlElements = getChildList(parent);
if (childlElements == null)
return null;
for (int i = 0; i < childlElements.size(); i++) {
Element childElement = childlElements.get(i);
Map attrMap = getNodeAttrMap(childElement);
allAttrMap.put(i, attrMap);
}
return allAttrMap;
}
/**
* @param xmlFilePath
* @param nodeName
* @return @参数描述 :
* @方法功能描述:根据xml文件名路径和指定的节点名称得到指定节点所有子节点的所有属性集合
* @方法名:getNameNodeAllAttributeMap
* @返回类型：Map
* @时间：2011-4-18下午04:51:46
*/
@SuppressWarnings("unchecked")
public T getNameNodeAllAttributeMap(String xmlFilePath, String nodeName, Flag flag) {
nodeName = nodeName.trim();
Map allAttrMap = null;
Map> mostKidsAllAttriMap = new HashMap>();
if (xmlFilePath == null || nodeName == null || xmlFilePath.equals("") || nodeName.equals(""))
return null;
switch (flag) {
case one:
Element nameNode = getNameNode(xmlFilePath, nodeName, Flag.one);
allAttrMap = getNodeAttrMap(nameNode);
return (T) allAttrMap;
case more:
List nameKidsElements = getNameNode(xmlFilePath, nodeName, Flag.more);
for (int i = 0; i < nameKidsElements.size(); i++) {
Element kid = nameKidsElements.get(i);
allAttrMap = getNodeAttrMap(kid);
mostKidsAllAttriMap.put(i, allAttrMap);
}
return (T) mostKidsAllAttriMap;
}
return null;
}
/**
* @param element
* @方法功能描述:遍历指定的节点下所有的节点
* @方法名:ransack
* @参数描述 :
* @返回类型：void
* @时间：2011-4-18下午05:25:41
*/
public List ransack(Element element, List allkidsList) {
if (element == null)
return null;
if (hasChild(element)) {
List kids = getChildList(element);
for (Element e : kids) {
allkidsList.add(e);
ransack(e, allkidsList);
}
}
return allkidsList;
}
/**
* @param element
* @param nodeName
* @return @参数描述 :
* @方法功能描述:得到指定节点下的指定节点集合
* @方法名:getNameElement
* @返回类型：Element
* @时间：2011-4-18下午06:18:56
*/
public List getNameElement(Element element, String nodeName) {
nodeName = nodeName.trim();
List kidsElements = new ArrayList();
if (element == null)
return null;
if (nodeName == null || nodeName.equals(""))
return null;
List allKids = ransack(element, new ArrayList());
if (allKids == null)
return null;
for (int i = 0; i < allKids.size(); i++) {
Element kid = allKids.get(i);
if (nodeName.equals(kid.getName()))
kidsElements.add(kid);
}
return kidsElements;
}
/**
* @param element
* @方法功能描述:验证节点是否唯一
* @方法名:validateSingle
* @返回类型：int 节点唯一返回1, 节点不唯一返回大于一的整型数据
* @时间：2011-4-20下午04:36:22
*/
public int validateSingle(Element element) {
int j = 1;
if (element == null)
return j;
Element parent = element.getParent();
List kids = getChildList(parent);
for (Element kid : kids) {
if (element.equals(kid))
j++;
}
return j;
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy