net.bluemind.utils

Class DOMUtils

java.lang.Object

net.bluemind.utils.DOMUtils

public final class DOMUtils
extends java.lang.Object

Utility methods to extract data from a DOM.

Constructor Summary

Constructors

Constructor and Description
DOMUtils()

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Document	createDoc(java.lang.String namespace, java.lang.String rootElement)
static org.w3c.dom.Element	createElement(org.w3c.dom.Element parent, java.lang.String elementName)
static org.w3c.dom.Element	createElementAndText(org.w3c.dom.Element parent, java.lang.String elementName, java.lang.String text)
static org.w3c.dom.Element	findElementWithUniqueAttribute(org.w3c.dom.Element root, java.lang.String elementName, java.lang.String attribute, java.lang.String attributeValue)
static void	forEachElement(org.w3c.dom.Element root, java.lang.String elementName, java.util.function.Consumer<org.w3c.dom.Element> cons)
static java.lang.String[][]	getAttributes(org.w3c.dom.Element root, java.lang.String elementName, java.lang.String[] wantedAttributes) Renvoie sous la forme d'un tableau la valeur des attributs donnés pour toutes les occurences d'un élément donnée dans le dom et getAttributes(<toto>, "titi", { "id", "val" }) renvoie { { "a", "ba" } { "b", "bb" } }
static java.lang.String	getElementAttribute(org.w3c.dom.Element root, java.lang.String elementName, java.lang.String attribute) Renvoie la valeur de l'attribut donné, d'un élément donné qui doit être unique sous l'élément racine
static java.lang.String	getElementText(org.w3c.dom.Element node)
static java.lang.String	getElementText(org.w3c.dom.Element root, java.lang.String elementName)
static java.lang.String[]	getTexts(org.w3c.dom.Element root, java.lang.String elementName)
static org.w3c.dom.Element	getUniqueElement(org.w3c.dom.Element root, java.lang.String elementName) Renvoie une élément qui doit être unique dans le document.
static java.lang.String	logDom(org.w3c.dom.Document doc)
static org.w3c.dom.Document	parse(java.io.File f)
static org.w3c.dom.Document	parse(java.io.InputStream is)
static void	saxParse(java.io.InputStream is, org.xml.sax.helpers.DefaultHandler handler)
static void	serialise(org.w3c.dom.Document doc, java.io.OutputStream out)
static java.lang.String	stripNonValidXMLCharacters(java.lang.String in) This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMUtils

public DOMUtils()

Method Detail

getElementText

public static java.lang.String getElementText(org.w3c.dom.Element root,
                                              java.lang.String elementName)

getElementText

public static java.lang.String getElementText(org.w3c.dom.Element node)

getTexts

public static java.lang.String[] getTexts(org.w3c.dom.Element root,
                                          java.lang.String elementName)

getAttributes

public static java.lang.String[][] getAttributes(org.w3c.dom.Element root,
                                                 java.lang.String elementName,
                                                 java.lang.String[] wantedAttributes)

Renvoie sous la forme d'un tableau la valeur des attributs donnés pour toutes les occurences d'un élément donnée dans le dom et getAttributes(<toto>, "titi", { "id", "val" }) renvoie { { "a", "ba" } { "b", "bb" } }

Parameters:

root -

elementName -

wantedAttributes -

Returns:

getElementAttribute

public static java.lang.String getElementAttribute(org.w3c.dom.Element root,
                                                   java.lang.String elementName,
                                                   java.lang.String attribute)

Renvoie la valeur de l'attribut donné, d'un élément donné qui doit être unique sous l'élément racine

Parameters:

root -

elementName -

attribute -

Returns:

getUniqueElement

public static org.w3c.dom.Element getUniqueElement(org.w3c.dom.Element root,
                                                   java.lang.String elementName)

Renvoie une élément qui doit être unique dans le document.

Parameters:

root -

elementName -

Returns:

forEachElement

public static void forEachElement(org.w3c.dom.Element root,
                                  java.lang.String elementName,
                                  java.util.function.Consumer<org.w3c.dom.Element> cons)

findElementWithUniqueAttribute

public static org.w3c.dom.Element findElementWithUniqueAttribute(org.w3c.dom.Element root,
                                                                 java.lang.String elementName,
                                                                 java.lang.String attribute,
                                                                 java.lang.String attributeValue)

stripNonValidXMLCharacters

public static final java.lang.String stripNonValidXMLCharacters(java.lang.String in)

This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard. For reference, please see the standard. This method will return an empty String if the input is null or empty.

Parameters:

in - The String whose non-valid characters we want to remove.

Returns:

The in String, stripped of non-valid characters.

createElementAndText

public static org.w3c.dom.Element createElementAndText(org.w3c.dom.Element parent,
                                                       java.lang.String elementName,
                                                       java.lang.String text)

createElement

public static org.w3c.dom.Element createElement(org.w3c.dom.Element parent,
                                                java.lang.String elementName)

serialise

public static void serialise(org.w3c.dom.Document doc,
                             java.io.OutputStream out)
                      throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

logDom

public static java.lang.String logDom(org.w3c.dom.Document doc)
                               throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

parse

public static org.w3c.dom.Document parse(java.io.InputStream is)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

parse

public static org.w3c.dom.Document parse(java.io.File f)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

createDoc

public static org.w3c.dom.Document createDoc(java.lang.String namespace,
                                             java.lang.String rootElement)
                                      throws javax.xml.parsers.ParserConfigurationException,
                                             javax.xml.parsers.FactoryConfigurationError

Throws:

javax.xml.parsers.ParserConfigurationException

javax.xml.parsers.FactoryConfigurationError

saxParse

public static void saxParse(java.io.InputStream is,
                            org.xml.sax.helpers.DefaultHandler handler)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Throws:

org.xml.sax.SAXException

java.io.IOException