org.dspace.app.util

Class XMLUtils

java.lang.Object

org.dspace.app.util.XMLUtils

public class XMLUtils
extends java.lang.Object

Simple class to read information from small XML using DOM manipulation

Author:

Andrea Bollini

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getElementAttribute(org.w3c.dom.Element dataRoot, java.lang.String name, java.lang.String attr)
static java.util.List<org.w3c.dom.Element>	getElementList(org.w3c.dom.Element dataRoot, java.lang.String name)
static java.lang.String	getElementValue(org.w3c.dom.Element dataRoot, java.lang.String name)
static java.util.List<java.lang.String[]>	getElementValueArrayList(org.w3c.dom.Element rootElement, java.lang.String subElementName, java.lang.String... fieldsName) root/subElement[]/field1, field2, fieldN
static java.util.List<java.lang.String>	getElementValueList(org.w3c.dom.Element rootElement, java.lang.String subElementName)
static org.w3c.dom.Element	getSingleElement(org.w3c.dom.Element dataRoot, java.lang.String name) Return the first element child with the specified name

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

getElementList

public static java.util.List<org.w3c.dom.Element> getElementList(org.w3c.dom.Element dataRoot,
                                                 java.lang.String name)

Parameters:

rootElement - the starting node

subElementName - the name of the subelement to find

Returns:

the list of all DOM Element with the provided name direct child of the starting node

getElementAttribute

public static java.lang.String getElementAttribute(org.w3c.dom.Element dataRoot,
                                   java.lang.String name,
                                   java.lang.String attr)

Parameters:

dataRoot - the starting node

name - the name of the sub element

attr - the attribute to get

Returns:

the value of the attribute for the sub element with the specified name in the starting node

getElementValue

public static java.lang.String getElementValue(org.w3c.dom.Element dataRoot,
                               java.lang.String name)

Parameters:

dataRoot - the starting node

name - the name of the sub element

Returns:

the text content of the sub element with the specified name in the starting node

getSingleElement

public static org.w3c.dom.Element getSingleElement(org.w3c.dom.Element dataRoot,
                                   java.lang.String name)

Return the first element child with the specified name

Parameters:

dataRoot - the starting node

name - the name of sub element to look for

Returns:

the first child element or null if no present

getElementValueList

public static java.util.List<java.lang.String> getElementValueList(org.w3c.dom.Element rootElement,
                                                   java.lang.String subElementName)

Parameters:

rootElement - the starting node

subElementName - the name of the subelement to find

Returns:

a list of string including all the text contents of the sub element with the specified name. If there are not sub element with the supplied name the method will return null

getElementValueArrayList

public static java.util.List<java.lang.String[]> getElementValueArrayList(org.w3c.dom.Element rootElement,
                                                          java.lang.String subElementName,
                                                          java.lang.String... fieldsName)

root/subElement[]/field1, field2, fieldN

Parameters:

rootElement - the starting node

subElementName - the name of the sub element to work on

fieldsName - the names of the sub-sub-elements from which get the text content

Returns:

a list of array strings. The length of the array is equals to the number of fields required. For any fields the first textual value found in the sub element is used, null if no value is present