Package net.bluemind.utils

Class DOMUtils

java.lang.Object

net.bluemind.utils.DOMUtils

public final class DOMUtils
extends Object

Utility methods to extract data from a DOM.

Constructor Summary

Constructors

Constructor	Description
DOMUtils()

Method Summary

Modifier and Type	Method	Description
static int	countElementsForTag(Element root, String tagName)
static Document	createDoc(String namespace, String rootElement)
static Element	createElement(Element parent, String elementName)
static Element	createElementAndText(Element parent, String elementName, String text)
static Element	createElementAndText(Element parent, String namespace, String elementName, String text)
static Element	findElementWithUniqueAttribute(Element root, String elementName, String attribute, String attributeValue)
static void	forEachElement(Element root, String elementName, Consumer<Element> cons)
static String[][]	getAttributes(Element root, String elementName, 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 String	getElementAttribute(Element root, String elementName, String attribute)	Renvoie la valeur de l'attribut donné, d'un élément donné qui doit être unique sous l'élément racine
static String	getElementText(Element node)
static String	getElementText(Element root, String elementName)
static String[]	getTexts(Element root, String elementName)
static Element	getUniqueElement(Element root, String elementName)	Renvoie une élément qui doit être unique dans le document.
static String	logDom(Document doc)
static Document	parse(File f)
static Document	parse(InputStream is)
static void	saxParse(InputStream is, DefaultHandler handler)
static void	serialise(Document doc, OutputStream out)
static final String	stripNonValidXMLCharacters(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 Details

DOMUtils

public DOMUtils()

Method Details

getElementText

public static String getElementText(Element root,
 String elementName)

getElementText

public static String getElementText(Element node)

getTexts

public static String[] getTexts(Element root,
 String elementName)

countElementsForTag

public static int countElementsForTag(Element root,
 String tagName)

getAttributes

public static String[][] getAttributes(Element root,
 String elementName,
 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 String getElementAttribute(Element root,
 String elementName,
 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 Element getUniqueElement(Element root,
 String elementName)

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

Parameters:

root -

elementName -

Returns:

forEachElement

public static void forEachElement(Element root,
 String elementName,
 Consumer<Element> cons)

findElementWithUniqueAttribute

public static Element findElementWithUniqueAttribute(Element root,
 String elementName,
 String attribute,
 String attributeValue)

stripNonValidXMLCharacters

public static final String stripNonValidXMLCharacters(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 Element createElementAndText(Element parent,
 String elementName,
 String text)

createElementAndText

public static Element createElementAndText(Element parent,
 String namespace,
 String elementName,
 String text)

createElement

public static Element createElement(Element parent,
 String elementName)

serialise

public static void serialise(Document doc,
 OutputStream out)
                      throws TransformerException

Throws:

TransformerException

logDom

public static String logDom(Document doc)
                     throws TransformerException

Throws:

TransformerException

parse

public static Document parse(InputStream is)
                      throws SAXException,
IOException,
ParserConfigurationException,
FactoryConfigurationError

Throws:

SAXException

IOException

ParserConfigurationException

FactoryConfigurationError

parse

public static Document parse(File f)
                      throws SAXException,
IOException,
ParserConfigurationException,
FactoryConfigurationError

Throws:

SAXException

IOException

ParserConfigurationException

FactoryConfigurationError

createDoc

public static Document createDoc(String namespace,
 String rootElement)
                          throws ParserConfigurationException,
FactoryConfigurationError

Throws:

ParserConfigurationException

FactoryConfigurationError

saxParse

public static void saxParse(InputStream is,
 DefaultHandler handler)
                     throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException