org.apache.oodt.commons.xml

Class DOMUtil

java.lang.Object

org.apache.oodt.commons.xml.DOMUtil

public class DOMUtil
extends Object

This class was adapted from an O'Reilly site on DOM utilities. It contains a few helper methods to make extracting out XML text from DOM representations a little easier.

Version:

1.0

Author:

mattmann

Constructor Summary

Constructors

Constructor and Description
DOMUtil()

Method Summary

Modifier and Type	Method and Description
static Element	getFirstElement(Element element, String name) Method returns the First occurence of Element 'name' in the DOM Node 'element'.
static String	getSimpleElementText(Element node) *
static String	getSimpleElementText(Element node, String name) *

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMUtil

public DOMUtil()

Method Detail

getFirstElement

public static Element getFirstElement(Element element,
                                      String name)
                               throws CommonsException

Method returns the First occurence of Element 'name' in the DOM Node 'element'.

Parameters:

element - The DOM Element node to traverse.

name - The XML name of the Element to return.

Returns:

Element "element" with Name "name"'s first occurence.

Throws:

CommonsException

getSimpleElementText

public static String getSimpleElementText(Element node,
                                          String name)
                                   throws CommonsException

*

This function is intended when you have a DOM element with no other DOM elements inside (i.e. here is text)

*

Parameters:

node - The DOM 'SimpleElement' as defined in the Function definition.

name - The name of the Text to retreive.

Returns:

the Text inbetween the simple element tags.

Throws:

CommonsException

getSimpleElementText

public static String getSimpleElementText(Element node)

*

This function is intended for use when you have merely text between an XML Element (i.e. text here).

Parameters:

node - The DOM XML Tag, with text inbetween.

Returns:

String text inbetween the simple element tag.