com.taobao.api.internal.util

Class XmlUtils

java.lang.Object

com.taobao.api.internal.util.XmlUtils

public final class XmlUtils
extends Object

Encapsulating XML common operations.

Since:

1.0, Jun 12, 2007

Version:

2.0 Jun 23, 2011, 2.1 Jan 11, 2013

Author:

fengsheng

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Modifier and Type	Method and Description
static Element	appendCDATAElement(Element parent, String tagName, String value) Appends the CDATA element to the parent element.
static void	appendElement(Element parent, Element child) Appends another element as a child element.
static Element	appendElement(Element parent, String tagName) Appends the child element to the parent element.
static Element	appendElement(Element parent, String tagName, String value) Appends the child element as well as value to the parent element.
static String	childNodeToString(Node node) Converts the Node/Element instance to XML payload.
static Element	createRootElement(String tagName) Creates a root element as well as a new document with specific tag name.
static String	encodeXml(String payload) Encode the XML payload to legality character.
static String	escapeXml(String payload)
static String	getAttributeValue(Element current, String attrName) Gets the specific attribute's value form current element.
static Element	getChildElement(Element parent, String tagName) Gets the immediately child element from the parent element.
static List<Element>	getChildElements(Element parent) Gets the immediately child elements list from the parent element.
static List<Element>	getChildElements(Element parent, String tagName) Gets the immediately child elements list from the parent element.
static String	getChildElementValue(Element parent, String tagName) Gets the value of the immediately child element by tag name under the given parent element.
static Document	getDocument(File file) Parses the content of the given XML file as an XML document.
static Document	getDocument(InputSource xml, InputStream xsd) Parses the content of the given stream as an XML document.
static Element	getElement(Element parent, String tagName) Gets the immediately descendant element from the parent element.
static List<Element>	getElements(Element parent, String tagName) Gets the descendant elements list from the parent element.
static String	getElementValue(Element element) Gets the text value of current element.
static String	getElementValue(Element parent, String tagName) Gets the value of the child element by tag name under the given parent element.
static Element	getRootElementFromFile(File xml) Gets the root element from given XML file.
static Element	getRootElementFromStream(InputStream xml) Gets the root element from input stream.
static Element	getRootElementFromStream(InputStream xml, InputStream xsd) Gets the root element from input stream.
static Element	getRootElementFromString(String payload) Gets the root element from the given XML payload.
static Document	newDocument() Creates a new document instance.
static String	nodeToString(Node node) Converts the Node/Document/Element instance to XML payload.
static void	saveToXml(Node doc, File file) Saves the node/document/element as XML file.
static void	saveToXml(Node doc, File file, String charset) Saves the node/document/element as XML file.
static void	setNamespace(Element element, String namespace, String schemaLocation) Sets the namespace to specific element.
static void	validateXml(InputStream xml, InputStream xsd) Validates the XML file via the given XML schema file.
static void	validateXml(Node root, InputStream xsd) Validates the XML file via the given XML schema file.
static String	xmlToHtml(String payload, File xsltFile) Transforms the XML content to XHTML/HTML format string with the XSL.
static String	xmlToString(File file) Converts the an XML file to XML payload.
static String	xmlToString(InputStream in) Converts the an XML file input stream to XML payload.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlUtils

public XmlUtils()

Method Detail

newDocument

public static Document newDocument()
                            throws ApiException

Creates a new document instance.

Returns:

a new document instance

Throws:

ApiException - problem creating a new document

getDocument

public static Document getDocument(File file)
                            throws ApiException

Parses the content of the given XML file as an XML document.

Parameters:

file - the XML file instance

Returns:

the document instance representing the entire XML document

Throws:

ApiException - problem parsing the XML file

getDocument

public static Document getDocument(InputSource xml,
                                   InputStream xsd)
                            throws ApiException

Parses the content of the given stream as an XML document.

Parameters:

xml - the XML file input stream

Returns:

the document instance representing the entire XML document

Throws:

ApiException - problem parsing the XML input stream

createRootElement

public static Element createRootElement(String tagName)
                                 throws ApiException

Creates a root element as well as a new document with specific tag name.

Parameters:

tagName - the name of the root element

Returns:

a new element instance

Throws:

ApiException - problem generating a new document

getRootElementFromStream

public static Element getRootElementFromStream(InputStream xml)
                                        throws ApiException

Gets the root element from input stream.

Parameters:

xml - the XML file input stream

Returns:

the root element of parsed document

Throws:

ApiException - problem parsing the XML file input stream

getRootElementFromStream

public static Element getRootElementFromStream(InputStream xml,
                                               InputStream xsd)
                                        throws ApiException

Gets the root element from input stream.

Parameters:

xml - the XML file input stream

Returns:

the root element of parsed document

Throws:

ApiException - problem parsing the XML file input stream

getRootElementFromFile

public static Element getRootElementFromFile(File xml)
                                      throws ApiException

Gets the root element from given XML file.

Parameters:

xml - the name of the XML file

Returns:

the root element of parsed document

Throws:

ApiException - problem parsing the XML file

getRootElementFromString

public static Element getRootElementFromString(String payload)
                                        throws ApiException

Gets the root element from the given XML payload.

Parameters:

payload - the XML payload representing the XML file.

Returns:

the root element of parsed document

Throws:

ApiException - problem parsing the XML payload

getElements

public static List<Element> getElements(Element parent,
                                        String tagName)

Gets the descendant elements list from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name

Returns:

the NOT NULL descendant elements list

getElement

public static Element getElement(Element parent,
                                 String tagName)

Gets the immediately descendant element from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name.

Returns:

immediately descendant element of parent element, NULL otherwise.

getChildElements

public static List<Element> getChildElements(Element parent,
                                             String tagName)

Gets the immediately child elements list from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name

Returns:

the NOT NULL immediately child elements list

getChildElements

public static List<Element> getChildElements(Element parent)

Gets the immediately child elements list from the parent element.

Parameters:

parent - the parent element in the element tree

Returns:

the NOT NULL immediately child elements list

getChildElement

public static Element getChildElement(Element parent,
                                      String tagName)

Gets the immediately child element from the parent element.

Parameters:

parent - the parent element in the element tree

tagName - the specified tag name

Returns:

immediately child element of parent element, NULL otherwise

getElementValue

public static String getElementValue(Element parent,
                                     String tagName)

Gets the value of the child element by tag name under the given parent element. If there is more than one child element, return the value of the first one.

Parameters:

parent - the parent element

tagName - the tag name of the child element

Returns:

value of the first child element, NULL if tag not exists

getChildElementValue

public static String getChildElementValue(Element parent,
                                          String tagName)

Gets the value of the immediately child element by tag name under the given parent element. If there is more than one child element, return the value of the first one.

Parameters:

parent - the parent element

tagName - the tag name of the child element

Returns:

value of the first child element, NULL if tag not exists

getElementValue

public static String getElementValue(Element element)

Gets the text value of current element.

Parameters:

parent - the current element

Returns:

text value of the element, NULL if element not exists

getAttributeValue

public static String getAttributeValue(Element current,
                                       String attrName)

Gets the specific attribute's value form current element.

Parameters:

current - current element

attrName - attribute name in current element

Returns:

attribute value if not null

appendElement

public static Element appendElement(Element parent,
                                    String tagName)

Appends the child element to the parent element.

Parameters:

parent - the parent element

tagName - the child element name

Returns:

the child element added to the parent element

appendElement

public static Element appendElement(Element parent,
                                    String tagName,
                                    String value)

Appends the child element as well as value to the parent element.

Parameters:

parent - the parent element

tagName - the child element name

value - the child element value

Returns:

the child element added to the parent element

appendElement

public static void appendElement(Element parent,
                                 Element child)

Appends another element as a child element.

Parameters:

parent - the parent element

child - the child element to append

appendCDATAElement

public static Element appendCDATAElement(Element parent,
                                         String tagName,
                                         String value)

Appends the CDATA element to the parent element.

Parameters:

parent - the parent element

tagName - the CDATA element name

value - the CDATA element value

Returns:

the CDATA element added to the parent element

childNodeToString

public static String childNodeToString(Node node)
                                throws ApiException

Converts the Node/Element instance to XML payload.

Parameters:

node - the node/element instance to convert

Returns:

the XML payload representing the node/element

Throws:

ApiException - problem converting XML to string

nodeToString

public static String nodeToString(Node node)
                           throws ApiException

Converts the Node/Document/Element instance to XML payload.

Parameters:

node - the node/document/element instance to convert

Returns:

the XML payload representing the node/document/element

Throws:

ApiException - problem converting XML to string

escapeXml

public static String escapeXml(String payload)

xmlToString

public static String xmlToString(File file)
                          throws ApiException

Converts the an XML file to XML payload.

Parameters:

file - the XML file instance

Returns:

the XML payload representing the XML file

Throws:

ApiException - problem transforming XML to string

xmlToString

public static String xmlToString(InputStream in)
                          throws ApiException

Converts the an XML file input stream to XML payload.

Parameters:

in - the XML file input stream

Returns:

the payload represents the XML file

Throws:

ApiException - problem transforming XML to string

saveToXml

public static void saveToXml(Node doc,
                             File file)
                      throws ApiException

Saves the node/document/element as XML file.

Parameters:

doc - the XML node/document/element to save

file - the XML file to save

Throws:

ApiException - problem persisting XML file

saveToXml

public static void saveToXml(Node doc,
                             File file,
                             String charset)
                      throws ApiException

Saves the node/document/element as XML file.

Parameters:

doc - the XML node/document/element to save

file - the XML file to save

charset - the string encoding charset

Throws:

ApiException - problem persisting XML file

validateXml

public static void validateXml(InputStream xml,
                               InputStream xsd)
                        throws ApiException

Validates the XML file via the given XML schema file.

Parameters:

xml - the XML file to validate

xsd - the XML schema file

Throws:

ApiException - error occurs if validation fail

validateXml

public static void validateXml(Node root,
                               InputStream xsd)
                        throws ApiException

Validates the XML file via the given XML schema file.

Parameters:

root - the root element of XML

xsd - the XML schema file

Throws:

ApiException - error occurs if validation fail

xmlToHtml

public static String xmlToHtml(String payload,
                               File xsltFile)
                        throws ApiException

Transforms the XML content to XHTML/HTML format string with the XSL.

Parameters:

payload - the XML payload to convert

xsltFile - the XML stylesheet file

Returns:

the transformed XHTML/HTML format string

Throws:

ApiException - problem converting XML to HTML

setNamespace

public static void setNamespace(Element element,
                                String namespace,
                                String schemaLocation)

Sets the namespace to specific element.

Parameters:

element - the element to set

namespace - the namespace to set

schemaLocation - the XML schema file location URI

encodeXml

public static String encodeXml(String payload)
                        throws ApiException

Encode the XML payload to legality character.

Parameters:

payload - the XML payload to encode

Returns:

the encoded XML payload

Throws:

ApiException - problem encoding the XML payload