XmlHelper (java-common-helper 2.3 API)

java.lang.Object
- com.library.common.XmlHelper

```
public class XmlHelper
extends Object
```
General convenience methods for working with XML

构造器概要

构造器
构造器和说明

XmlHelper()

构造器
构造器和说明
`XmlHelper()`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`void`	`addAttribute(org.dom4j.Element Element, String AttributeName, String AttributeValue)` Add the attribute name and value under specified element
`org.dom4j.Element`	`addChildElement(org.dom4j.Element ParentElement, String strElementNmae)` Add a element under specified parent element
`void`	`addComment(org.dom4j.Element Element, String strComment)` Add the specified comment under specified element
`void`	`applyXSL(String strInXMLFileName, String strXSLFileName, String strOutHTMLFileName)` Transform XML to HTML
`void`	`createDocument()` Create the instance of the Document class
`org.dom4j.Element`	`createDocumentRoot(String strRootName)` Create a root element for object document
`void`	`createProcessingInstruction(String strProcessingInstructionName, String strProcessingInstructionValue)` Create the Processing Instruction
`org.dom4j.Attribute`	`findAttributeByXPath(String xpath)` Get attribute by XPath
`org.dom4j.Element`	`findElementByXPath(String xpath)` Get element by XPath
`List<org.dom4j.Element>`	`findElementsByXPath(String xpath)` Find elements by x path list.
`void`	`getAllDifferences(String xml1, String xml2)` Gets all differences.
`org.dom4j.Attribute`	`getAttribute(org.dom4j.Element element, String strAttributeNmae)` Get the attribute of the specified element
`String`	`getAttributeText(org.dom4j.Element element, String strAttributeNmae)` Get the attribute text of the specified element
`org.dom4j.Element`	`getChildElement(org.dom4j.Element ParentElement, String strElementNmae)` Get the specified child element
`List<org.dom4j.Element>`	`getChildElements(org.dom4j.Element ParentElement, String strElementNmae)` Get the specified child element
`String`	`getChildText(org.dom4j.Element ParentElement, String strElementNmae)` Get the text of the specified child element
`int`	`getDiffCount(String xml1, String xml2)` Get the number of the difference
`org.dom4j.Document`	`getDocument()` Gets document.
`org.dom4j.Element`	`getRootElement()` Get the root element
`String`	`getText(org.dom4j.Element element)` Get the text of the specified element
`boolean`	`isIdentical(String xml1, String xml2)` Two XML documents are considered to be "identical" if they contain the same elements and attributes in the same order.
`boolean`	`isSimilar(String xml1, String xml2)` Two documents are considered to be "similar" if they contain the same elements and attributes regardless of order.
`void`	`iterateElements(String xpath, HashMap<String,String> hm)` Iterate all elements under specified parent element and put the element name and element text into HashMap
`org.dom4j.Document`	`readXMLFile(String sFileName)` Read and parse XML file
`void`	`removeAttribute(org.dom4j.Element Element, String strAttributeNmae)` Remove the specified Attribute under specified element
`void`	`removeChildElement(org.dom4j.Element ParentElement, String strElementNmae)` Remove the specified child Element under Parent element
`void`	`saveTo(String strFileName)` Save document to specified XML file
`void`	`setAttributeText(org.dom4j.Element element, String strAttributeNmae, String strAttributeValue)` Set the attribute text of the specified element
`void`	`setDocument(org.dom4j.Document document)` Sets document.
`void`	`setText(org.dom4j.Element Element, String strText)` Set the element text for the specified element
`XmlHelper`	`strToXML(String str)` Str to xml xml helper.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - XmlHelper
```
public XmlHelper()
```
- 方法详细资料
  - getDocument
```
public org.dom4j.Document getDocument()
```
    Gets document.
    
    返回:
    
    the document
  - setDocument
```
public void setDocument(org.dom4j.Document document)
```
    Sets document.
    
    参数:
    
    document - the document
  - strToXML
```
public XmlHelper strToXML(String str)
```
    Str to xml xml helper.
    
    参数:
    
    str - the str
    
    返回:
    
    the xml helper
  - createDocument
```
public void createDocument()
```
    Create the instance of the Document class
  - createProcessingInstruction
```
public void createProcessingInstruction(String strProcessingInstructionName,
                                        String strProcessingInstructionValue)
                                 throws org.dom4j.DocumentException
```
    Create the Processing Instruction
    
    参数:
    
    strProcessingInstructionName - the str processing instruction name
    
    strProcessingInstructionValue - the str processing instruction value
    
    抛出:
    
    org.dom4j.DocumentException - the document exception
  - createDocumentRoot
```
public org.dom4j.Element createDocumentRoot(String strRootName)
```
    Create a root element for object document
    
    参数:
    
    strRootName - the root element name to be created
    
    返回:
    
    Element element
  - addChildElement
```
public org.dom4j.Element addChildElement(org.dom4j.Element ParentElement,
                                         String strElementNmae)
```
    Add a element under specified parent element
    
    参数:
    
    ParentElement - specified parent element
    
    strElementNmae - the element name to be added
    
    返回:
    
    Element element
  - setText
```
public void setText(org.dom4j.Element Element,
                    String strText)
```
    Set the element text for the specified element
    
    参数:
    
    Element - the element
    
    strText - the text to be set
  - addAttribute
```
public void addAttribute(org.dom4j.Element Element,
                         String AttributeName,
                         String AttributeValue)
```
    Add the attribute name and value under specified element
    
    参数:
    
    Element - the element
    
    AttributeName - the attribute name
    
    AttributeValue - the attribute value
  - addComment
```
public void addComment(org.dom4j.Element Element,
                       String strComment)
```
    Add the specified comment under specified element
    
    参数:
    
    Element - the element
    
    strComment - the str comment
  - removeChildElement
```
public void removeChildElement(org.dom4j.Element ParentElement,
                               String strElementNmae)
```
    Remove the specified child Element under Parent element
    
    参数:
    
    ParentElement - the parent element
    
    strElementNmae - the element name to be removed
  - removeAttribute
```
public void removeAttribute(org.dom4j.Element Element,
                            String strAttributeNmae)
```
    Remove the specified Attribute under specified element
    
    参数:
    
    Element - the element
    
    strAttributeNmae - the attribute name to be removed
  - saveTo
```
public void saveTo(String strFileName)
```
    Save document to specified XML file
    
    参数:
    
    strFileName - the XML file name to be saved
  - readXMLFile
```
public org.dom4j.Document readXMLFile(String sFileName)
```
    Read and parse XML file
    
    参数:
    
    sFileName - The full path of the XML file
    
    返回:
    
    Document document
  - getRootElement
```
public org.dom4j.Element getRootElement()
```
    Get the root element
    
    返回:
    
    Element root element
  - getChildElement
```
public org.dom4j.Element getChildElement(org.dom4j.Element ParentElement,
                                         String strElementNmae)
```
    Get the specified child element
    
    参数:
    
    ParentElement - the parent element
    
    strElementNmae - the str element nmae
    
    返回:
    
    Element child element
  - getChildElements
```
public List<org.dom4j.Element> getChildElements(org.dom4j.Element ParentElement,
                                                String strElementNmae)
```
    Get the specified child element
    
    参数:
    
    ParentElement - the parent element
    
    strElementNmae - the str element nmae
    
    返回:
    
    Element child elements
  - getText
```
public String getText(org.dom4j.Element element)
```
    Get the text of the specified element
    
    参数:
    
    element - the element
    
    返回:
    
    String text
  - getChildText
```
public String getChildText(org.dom4j.Element ParentElement,
                           String strElementNmae)
```
    Get the text of the specified child element
    
    参数:
    
    ParentElement - the parent element
    
    strElementNmae - the str element nmae
    
    返回:
    
    child text
  - getAttribute
```
public org.dom4j.Attribute getAttribute(org.dom4j.Element element,
                                        String strAttributeNmae)
```
    Get the attribute of the specified element
    
    参数:
    
    element - the element
    
    strAttributeNmae - the str attribute nmae
    
    返回:
    
    attribute attribute
  - getAttributeText
```
public String getAttributeText(org.dom4j.Element element,
                               String strAttributeNmae)
```
    Get the attribute text of the specified element
    
    参数:
    
    element - the element
    
    strAttributeNmae - the str attribute nmae
    
    返回:
    
    attribute text
  - setAttributeText
```
public void setAttributeText(org.dom4j.Element element,
                             String strAttributeNmae,
                             String strAttributeValue)
```
    Set the attribute text of the specified element
    
    参数:
    
    element - the element
    
    strAttributeNmae - the str attribute nmae
    
    strAttributeValue - the str attribute value
  - findElementByXPath
```
public org.dom4j.Element findElementByXPath(String xpath)
```
    Get element by XPath
    
    参数:
    
    xpath - such as /company/department[name = 'HR']/employee[1]
    
    返回:
    
    Element element
  - findElementsByXPath
```
public List<org.dom4j.Element> findElementsByXPath(String xpath)
```
    Find elements by x path list.
    
    参数:
    
    xpath - the xpath
    
    返回:
    
    the list
  - findAttributeByXPath
```
public org.dom4j.Attribute findAttributeByXPath(String xpath)
```
    Get attribute by XPath
    
    参数:
    
    xpath - such as /company/department[name = 'HR']/employee[1]/@salary
    
    返回:
    
    Attribute attribute
  - iterateElements
```
public void iterateElements(String xpath,
                            HashMap<String,String> hm)
```
    Iterate all elements under specified parent element and put the element name and element text into HashMap
    
    参数:
    
    xpath - the xpath
    
    hm - the hm
  - applyXSL
```
public void applyXSL(String strInXMLFileName,
                     String strXSLFileName,
                     String strOutHTMLFileName)
```
    Transform XML to HTML
    
    参数:
    
    strInXMLFileName - the str in xml file name
    
    strXSLFileName - the str xsl file name
    
    strOutHTMLFileName - the str out html file name
  - isSimilar
```
public boolean isSimilar(String xml1,
                         String xml2)
```
    Two documents are considered to be "similar" if they contain the same elements and attributes regardless of order.
    
    参数:
    
    xml1 - the xml 1
    
    xml2 - the xml 2
    
    返回:
    
    boolean boolean
  - isIdentical
```
public boolean isIdentical(String xml1,
                           String xml2)
```
    Two XML documents are considered to be "identical" if they contain the same elements and attributes in the same order.
    
    参数:
    
    xml1 - the xml 1
    
    xml2 - the xml 2
    
    返回:
    
    boolean boolean
  - getAllDifferences
```
public void getAllDifferences(String xml1,
                              String xml2)
                       throws SAXException,
                              IOException
```
    Gets all differences.
    
    参数:
    
    xml1 - the xml 1
    
    xml2 - the xml 2
    
    抛出:
    
    SAXException - the sax exception
    
    IOException - the io exception
  - getDiffCount
```
public int getDiffCount(String xml1,
                        String xml2)
                 throws SAXException,
                        IOException
```
    Get the number of the difference
    
    参数:
    
    xml1 - the xml 1
    
    xml2 - the xml 2
    
    返回:
    
    the diff count
    
    抛出:
    
    SAXException - the sax exception
    
    IOException - the io exception

类 XmlHelper

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

XmlHelper

方法详细资料

getDocument

setDocument

strToXML

createDocument

createProcessingInstruction

createDocumentRoot

addChildElement

setText

addAttribute

addComment

removeChildElement

removeAttribute

saveTo

readXMLFile

getRootElement

getChildElement

getChildElements

getText

getChildText

getAttribute

getAttributeText

setAttributeText

findElementByXPath

findElementsByXPath

findAttributeByXPath

iterateElements

applyXSL

isSimilar

isIdentical

getAllDifferences

getDiffCount