org.ow2.orchestra.util
Class XmlUtil

java.lang.Object
  org.ow2.orchestra.util.XmlUtil

public abstract class XmlUtil
extends java.lang.Object

convenience methods to make reading org.w3c.dom models easier.

Author:

Tom Baeyens

Nested Class Summary

static class

XmlUtil.NamespaceValue

Method Summary

static boolean	areNodeEquals(org.w3c.dom.Node n1, org.w3c.dom.Node n2) Test the equality of two nodes following same conditions that org.w3c.dom.Node.isEqualNode(Node n) except for prefix.
static java.lang.String	attribute(org.w3c.dom.Element element, java.lang.String attributeName) the attribute value or null if the attribute is not present
static XmlUtil.NamespaceValue	attributeNamespaceValue(org.w3c.dom.Element element, java.lang.String attributeName)
static javax.xml.namespace.QName	attributeQName(org.w3c.dom.Element element, java.lang.String attributeName)
static java.util.List<org.w3c.dom.Attr>	attributes(org.w3c.dom.Element element)
static org.w3c.dom.Document	copyDocument(org.w3c.dom.Document src)
static org.w3c.dom.Element	element(org.w3c.dom.Element element)
static org.w3c.dom.Element	element(org.w3c.dom.Element element, java.lang.String tagName)
static org.w3c.dom.Element	element(org.w3c.dom.Element element, java.lang.String ns, java.lang.String localName)
static java.util.List<org.w3c.dom.Element>	elements(org.w3c.dom.Element element)
static java.util.List<org.w3c.dom.Element>	elements(org.w3c.dom.Element element, java.util.Set<java.lang.String> allowedTagNames)
static java.util.List<org.w3c.dom.Element>	elements(org.w3c.dom.Element element, java.lang.String tagName)
static java.util.List<org.w3c.dom.Element>	elements(org.w3c.dom.Element father, java.lang.String ns, java.lang.String localName)
static java.util.List<org.w3c.dom.Element>	elementsQName(org.w3c.dom.Element element, java.util.Set<javax.xml.namespace.QName> allowedTagNames)
static java.lang.String	errorMessageAttribute(org.w3c.dom.Element element, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String message)
static java.lang.String	getContentText(org.w3c.dom.Element element)
static org.w3c.dom.Document	getDocumentFromFile(java.io.File xmlFile)
static org.w3c.dom.Document	getDocumentFromInputStream(java.io.InputStream is)
static org.w3c.dom.Document	getDocumentFromReader(java.io.Reader r)
static org.w3c.dom.Document	getDocumentFromString(java.lang.String s)
static org.w3c.dom.Document	getDocumentFromString(java.lang.String s, boolean createProxy)
static org.w3c.dom.Document	getDocumentFromURL(java.net.URL xmlUrl)
static org.w3c.dom.Element	getDocumentWithOneElement(javax.xml.namespace.QName elementQName)
static java.lang.String	getNamespaceURI(org.w3c.dom.Node n, java.lang.String prefix)
static org.w3c.dom.Document	getNewDocument()
static java.io.ByteArrayOutputStream	getNodeAsBAOS(org.w3c.dom.Node n)
static javax.xml.namespace.QName	getQNameFromString(org.w3c.dom.Element element, java.lang.String qnameAsString)
static java.lang.String	getTagLocalName(org.w3c.dom.Element element)
static javax.xml.transform.TransformerFactory	getTransformerFactory()
static boolean	isTextOnly(org.w3c.dom.Element element)
static java.lang.Boolean	parseBooleanValue(java.lang.String valueText)
static java.util.List<java.lang.String>	parseCommaSeparatedList(java.lang.String commaSeparatedListText) parses comma or space separated list.
static java.util.List<java.lang.String>	parseList(org.w3c.dom.Element element, java.lang.String singularTagName)
static java.lang.String	toString(org.w3c.dom.Node node)
static void	writeXmlFile(org.w3c.dom.Document doc, java.io.File file) This method writes a DOM document to a file.

Methods inherited from class java.lang.Object

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

Method Detail

elements

public static java.util.List<org.w3c.dom.Element> elements(org.w3c.dom.Element element,
                                                           java.lang.String tagName)

elements

public static java.util.List<org.w3c.dom.Element> elements(org.w3c.dom.Element element,
                                                           java.util.Set<java.lang.String> allowedTagNames)

element

public static org.w3c.dom.Element element(org.w3c.dom.Element element,
                                          java.lang.String tagName)

element

public static org.w3c.dom.Element element(org.w3c.dom.Element element,
                                          java.lang.String ns,
                                          java.lang.String localName)

elements

public static java.util.List<org.w3c.dom.Element> elements(org.w3c.dom.Element element)

elements

public static java.util.List<org.w3c.dom.Element> elements(org.w3c.dom.Element father,
                                                           java.lang.String ns,
                                                           java.lang.String localName)

elementsQName

public static java.util.List<org.w3c.dom.Element> elementsQName(org.w3c.dom.Element element,
                                                                java.util.Set<javax.xml.namespace.QName> allowedTagNames)

element

public static org.w3c.dom.Element element(org.w3c.dom.Element element)

toString

public static java.lang.String toString(org.w3c.dom.Node node)

getContentText

public static java.lang.String getContentText(org.w3c.dom.Element element)

isTextOnly

public static boolean isTextOnly(org.w3c.dom.Element element)

attributes

public static java.util.List<org.w3c.dom.Attr> attributes(org.w3c.dom.Element element)

getTagLocalName

public static java.lang.String getTagLocalName(org.w3c.dom.Element element)

attribute

public static java.lang.String attribute(org.w3c.dom.Element element,
                                         java.lang.String attributeName)

the attribute value or null if the attribute is not present

parseBooleanValue

public static java.lang.Boolean parseBooleanValue(java.lang.String valueText)

errorMessageAttribute

public static java.lang.String errorMessageAttribute(org.w3c.dom.Element element,
                                                     java.lang.String attributeName,
                                                     java.lang.String attributeValue,
                                                     java.lang.String message)

parseList

public static java.util.List<java.lang.String> parseList(org.w3c.dom.Element element,
                                                         java.lang.String singularTagName)

parseCommaSeparatedList

public static java.util.List<java.lang.String> parseCommaSeparatedList(java.lang.String commaSeparatedListText)

parses comma or space separated list. A null return value means a wildcard.

Returns:

List of tokens or null if the commaSeparatedListText is null, '*', or empty

attributeNamespaceValue

public static XmlUtil.NamespaceValue attributeNamespaceValue(org.w3c.dom.Element element,
                                                             java.lang.String attributeName)

attributeQName

public static javax.xml.namespace.QName attributeQName(org.w3c.dom.Element element,
                                                       java.lang.String attributeName)

getTransformerFactory

public static javax.xml.transform.TransformerFactory getTransformerFactory()

getQNameFromString

public static javax.xml.namespace.QName getQNameFromString(org.w3c.dom.Element element,
                                                           java.lang.String qnameAsString)

getNamespaceURI

public static java.lang.String getNamespaceURI(org.w3c.dom.Node n,
                                               java.lang.String prefix)

getNewDocument

public static org.w3c.dom.Document getNewDocument()

writeXmlFile

public static void writeXmlFile(org.w3c.dom.Document doc,
                                java.io.File file)

This method writes a DOM document to a file.

Parameters:

doc - - doc to write

file - - dest file;

getNodeAsBAOS

public static java.io.ByteArrayOutputStream getNodeAsBAOS(org.w3c.dom.Node n)

getDocumentFromString

public static org.w3c.dom.Document getDocumentFromString(java.lang.String s)

getDocumentFromString

public static org.w3c.dom.Document getDocumentFromString(java.lang.String s,
                                                         boolean createProxy)

getDocumentFromInputStream

public static org.w3c.dom.Document getDocumentFromInputStream(java.io.InputStream is)

getDocumentFromReader

public static org.w3c.dom.Document getDocumentFromReader(java.io.Reader r)

getDocumentFromFile

public static org.w3c.dom.Document getDocumentFromFile(java.io.File xmlFile)

getDocumentFromURL

public static org.w3c.dom.Document getDocumentFromURL(java.net.URL xmlUrl)

getDocumentWithOneElement

public static org.w3c.dom.Element getDocumentWithOneElement(javax.xml.namespace.QName elementQName)

copyDocument

public static org.w3c.dom.Document copyDocument(org.w3c.dom.Document src)

areNodeEquals

public static boolean areNodeEquals(org.w3c.dom.Node n1,
                                    org.w3c.dom.Node n2)

Test the equality of two nodes following same conditions that org.w3c.dom.Node.isEqualNode(Node n) except for prefix. The two nodes prefix doesn't need to be equals.

Parameters:

n1 - First node

n2 - Second node

Returns:

true if the two nodes are equals, false otherwise