Package org.ofbiz.core.util

Class UtilXml

java.lang.Object

org.ofbiz.core.util.UtilXml

public class UtilXml
extends Object

Utilities methods to simplify dealing with JAXP & DOM XML parsing

Since:

2.0

Version:

$Revision: 1.1 $

Author:

David E. Jones

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UtilXml.LocalErrorHandler	Local error handler for entity resolver to DocumentBuilder parser.
static class	UtilXml.LocalResolver	Local entity resolver to handle J2EE DTDs.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	module

Constructor Summary

Constructors

Constructor	Description
UtilXml()

Method Summary

Modifier and Type	Method	Description
static Element	addChildElement(Element element, String childElementName, Document document)	Creates a child element with the given name and appends it to the element child node list.
static Element	addChildElementCDATAValue(Element element, String childElementName, String childElementValue, Document document)	Creates a child element with the given name and appends it to the element child node list.
static Element	addChildElementValue(Element element, String childElementName, String childElementValue, Document document)	Creates a child element with the given name and appends it to the element child node list.
static boolean	checkBoolean(String str)
static boolean	checkBoolean(String str, boolean defaultValue)
static String	checkEmpty(String string)
static String	checkEmpty(String string1, String string2)
static String	checkEmpty(String string1, String string2, String string3)
static List<Element>	childElementList(Element element, String childElementName)	Return a List of Element objects that have the given name and are immediate children of the given element; if name is null, all child elements will be included.
static String	childElementValue(Element element, String childElementName)	Return the text (node value) contained by the named child node.
static String	childElementValue(Element element, String childElementName, String defaultValue)	Return the text (node value) contained by the named child node or a default value if null.
static String	elementValue(Element element)	Return the text (node value) of the first node under this, works best if normalized.
static Element	firstChildElement(Element element, String childElementName)	Return the first child Element with the given name; if name is null returns the first element.
static Element	firstChildElement(Element element, String childElementName, String attrName, String attrValue)	Return the first child Element with the given name; if name is null returns the first element.
static Document	makeEmptyXmlDocument()
static Document	makeEmptyXmlDocument(String rootElementName)
static Document	readXmlDocument(InputStream is)
static Document	readXmlDocument(InputStream is, boolean validate, String docDescription)
static Document	readXmlDocument(String content)
static Document	readXmlDocument(String content, boolean validate)
static Document	readXmlDocument(URL url)
static Document	readXmlDocument(URL url, boolean validate)
static void	writeXmlDocument(OutputStream os, Document document)
static void	writeXmlDocument(String filename, Document document)
static String	writeXmlDocument(Document document)

Methods inherited from class java.lang.Object

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

Field Details

module

public static final String module

Constructor Details

UtilXml

public UtilXml()

Method Details

writeXmlDocument

public static String writeXmlDocument(Document document)
                               throws IOException

Throws:

IOException

writeXmlDocument

public static void writeXmlDocument(String filename,
 Document document)
                             throws FileNotFoundException,
IOException

Throws:

FileNotFoundException

IOException

writeXmlDocument

public static void writeXmlDocument(OutputStream os,
 Document document)
                             throws IOException

Throws:

IOException

readXmlDocument

public static Document readXmlDocument(String content)
                                throws SAXException,
ParserConfigurationException,
IOException

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

public static Document readXmlDocument(String content,
 boolean validate)
                                throws SAXException,
ParserConfigurationException,
IOException

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

public static Document readXmlDocument(URL url)
                                throws SAXException,
ParserConfigurationException,
IOException

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

public static Document readXmlDocument(URL url,
 boolean validate)
                                throws SAXException,
ParserConfigurationException,
IOException

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

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

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

public static Document readXmlDocument(InputStream is,
 boolean validate,
 String docDescription)
                                throws SAXException,
ParserConfigurationException,
IOException

Throws:

SAXException

ParserConfigurationException

IOException

makeEmptyXmlDocument

public static Document makeEmptyXmlDocument()

makeEmptyXmlDocument

public static Document makeEmptyXmlDocument(String rootElementName)

addChildElement

public static Element addChildElement(Element element,
 String childElementName,
 Document document)

Creates a child element with the given name and appends it to the element child node list.

addChildElementValue

public static Element addChildElementValue(Element element,
 String childElementName,
 String childElementValue,
 Document document)

Creates a child element with the given name and appends it to the element child node list. Also creates a Text node with the given value and appends it to the new elements child node list.

addChildElementCDATAValue

public static Element addChildElementCDATAValue(Element element,
 String childElementName,
 String childElementValue,
 Document document)

Creates a child element with the given name and appends it to the element child node list. Also creates a CDATASection node with the given value and appends it to the new elements child node list.

childElementList

public static List<Element> childElementList(Element element,
 String childElementName)

Return a List of Element objects that have the given name and are immediate children of the given element; if name is null, all child elements will be included.

firstChildElement

public static Element firstChildElement(Element element,
 String childElementName)

Return the first child Element with the given name; if name is null returns the first element.

firstChildElement

public static Element firstChildElement(Element element,
 String childElementName,
 String attrName,
 String attrValue)

Return the first child Element with the given name; if name is null returns the first element.

childElementValue

public static String childElementValue(Element element,
 String childElementName)

Return the text (node value) contained by the named child node.

childElementValue

public static String childElementValue(Element element,
 String childElementName,
 String defaultValue)

Return the text (node value) contained by the named child node or a default value if null.

elementValue

public static String elementValue(Element element)

Return the text (node value) of the first node under this, works best if normalized.

checkEmpty

public static String checkEmpty(String string)

checkEmpty

public static String checkEmpty(String string1,
 String string2)

checkEmpty

public static String checkEmpty(String string1,
 String string2,
 String string3)

checkBoolean

public static boolean checkBoolean(String str)

checkBoolean

public static boolean checkBoolean(String str,
 boolean defaultValue)