Package fr.becpg.common.dom

Class DOMUtils

java.lang.Object

fr.becpg.common.dom.DOMUtils

public class DOMUtils
extends Object

Méthodes utilitaires pour extraire des infos d'un DOM.

Version:

$Id: $Id

Author:

tom, matthieu

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DOMUtils()

Method Summary

Modifier and Type	Method	Description
static Document	createDoc()	createDoc.
static Element	createDoc(String rootNodeName)	createDoc.
static Element	createElement(Element parent, String elementName)	createElement.
static Element	createElementAndText(Element parent, String elementName, String text)	createElementAndText.
static Element	findElementWithUniqueAttribute(Element root, String elementName, String attribute, String attributeValue)	findElementWithUniqueAttribute.
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
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 root)	getElementText.
static String	getElementText(Element root, String elementName)	getElementText.
static String[]	getTexts(Element root, String elementName)	getTexts.
static Element	getUniqueElement(Element root, String elementName)	Renvoie une élément qui doit être unique dans le document.
static Element	getUniqueXPathElement(Element root, String xpath)	getUniqueXPathElement.
static String	getUniqueXPathTextElement(Element root, String xpath)	getUniqueXPathTextElement.
static NodeList	getXPathNodes(Element root, String xpath)	getXPathNodes.
static void	logDom(Document doc)	logDom.
static Document	parse(InputStream is)	parse.
static void	serialise(Document doc, OutputStream out)	serialise.
static void	serialise(Document doc, OutputStream out, boolean keepXmlDecl)	serialise.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.apache.commons.logging.Log logger

Constructor Details

DOMUtils

private DOMUtils()

Method Details

getElementText

public static String getElementText(Element root,
 String elementName)

getElementText.

Parameters:

root - a Element object.

elementName - a String object.

Returns:

a String object.

getElementText

public static String getElementText(Element root)

getElementText.

Parameters:

root - a Element object.

Returns:

a String object.

getTexts

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

getTexts.

Parameters:

root - a Element object.

elementName - a String object.

Returns:

an array of String objects.

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

 
  <toto>
   <titi id="a" val="ba"/>
   <titi id="b" val="bb"/>
  </toto>
  
 

 et getAttributes(<toto>, "titi", { "id", "val" }) renvoie

 { { "a", "ba" } { "b", "bb" } }
 

Parameters:

root - a Element object.

elementName - a String object.

wantedAttributes - an array of String objects.

Returns:

an array of String objects.

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 - a Element object.

elementName - a String object.

attribute - a String object.

Returns:

a String object.

getUniqueElement

public static Element getUniqueElement(Element root,
 String elementName)

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

Parameters:

root - a Element object.

elementName - a String object.

Returns:

a Element object.

getUniqueXPathElement

public static Element getUniqueXPathElement(Element root,
 String xpath)
                                     throws XPathExpressionException

getUniqueXPathElement.

Parameters:

root - a Element object.

xpath - a String object.

Returns:

a Element object.

Throws:

XPathExpressionException - if any.

getUniqueXPathTextElement

public static String getUniqueXPathTextElement(Element root,
 String xpath)
                                        throws XPathExpressionException

getUniqueXPathTextElement.

Parameters:

root - a Element object.

xpath - a String object.

Returns:

a String object.

Throws:

XPathExpressionException - if any.

getXPathNodes

public static NodeList getXPathNodes(Element root,
 String xpath)
                              throws XPathExpressionException

getXPathNodes.

Parameters:

root - a Element object.

xpath - a String object.

Returns:

a NodeList object.

Throws:

XPathExpressionException - if any.

findElementWithUniqueAttribute

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

findElementWithUniqueAttribute.

Parameters:

root - a Element object.

elementName - a String object.

attribute - a String object.

attributeValue - a String object.

Returns:

a Element object.

createElementAndText

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

createElementAndText.

Parameters:

parent - a Element object.

elementName - a String object.

text - a String object.

Returns:

a Element object.

createElement

public static Element createElement(Element parent,
 String elementName)

createElement.

Parameters:

parent - a Element object.

elementName - a String object.

Returns:

a Element object.

serialise

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

serialise.

Parameters:

doc - a Document object.

out - a OutputStream object.

Throws:

TransformerException - if any.

serialise

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

serialise.

Parameters:

doc - a Document object.

out - a OutputStream object.

keepXmlDecl - a boolean.

Throws:

TransformerException - if any.

logDom

public static void logDom(Document doc)
                   throws TransformerException

logDom.

Parameters:

doc - a Document object.

Throws:

TransformerException - if any.

parse

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

parse.

Parameters:

is - a InputStream object.

Returns:

a Document object.

Throws:

SAXException - if any.

IOException - if any.

ParserConfigurationException - if any.

FactoryConfigurationError - if any.

createDoc

public static Document createDoc()
                          throws ParserConfigurationException,
FactoryConfigurationError

createDoc.

Returns:

a Document object.

Throws:

ParserConfigurationException - if any.

FactoryConfigurationError - if any.

createDoc

public static Element createDoc(String rootNodeName)
                         throws ParserConfigurationException,
FactoryConfigurationError

createDoc.

Parameters:

rootNodeName - a String object.

Returns:

a Element object.

Throws:

ParserConfigurationException - if any.

FactoryConfigurationError - if any.