org.apache.ofbiz.base.util

Class UtilXml

java.lang.Object

org.apache.ofbiz.base.util.UtilXml

public final class UtilXml
extends Object

Utilities methods to simplify dealing with JAXP and DOM XML parsing

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and Description
static String	module

Method Summary

Modifier and Type	Method and 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	addChildElementNSElement(Element element, String childElementName, Document document, String nameSpaceUrl) Creates a child element with the given namespace supportive name and appends it to the element child node list.
static Element	addChildElementNSValue(Element element, String childElementName, String childElementValue, Document document, String nameSpaceUrl) Creates a child element with the given namespace supportive 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 String	childElementAttribute(Element element, String childElementName, String attributeName, String defaultValue) Return a named attribute of a named child node or a default if null.
static List<? extends Element>	childElementList(DocumentFragment fragment) Return a List of Element objects that are children of the given DocumentFragment
static List<? extends Element>	childElementList(Element element) Return a List of Element objects that are children of the given element
static List<? extends Element>	childElementList(Element element, Set<String> childElementNames) 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 List<? extends Element>	childElementList(Element element, String... childElementNames) 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 List<? extends 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 List<? extends Node>	childNodeList(Node node) Return a List of Node 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 LSOutput	createLSOutput(DOMImplementationLS impl, OutputStream os, String encoding) Returns a LSOutput instance.
static LSSerializer	createLSSerializer(DOMImplementationLS impl, boolean includeXmlDeclaration, boolean enablePrettyPrint) Returns a LSSerializer instance.
static Transformer	createOutputTransformer(String encoding, boolean omitXmlDeclaration, boolean indent, int indentAmount) Creates a JAXP TrAX Transformer suitable for pretty-printing an XML document.
static String	elementAttribute(Element element, String attrName, String defaultValue)
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) Return the first child Element returns the first element.
static Element	firstChildElement(Element element, Set<String> childElementNames) Return the first child Element returns the first element.
static Element	firstChildElement(Element element, String... childElementNames) Return the first child Element returns the first element.
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 Object	fromXml(InputStream input) Deserialize an object from an InputStream.
static Object	fromXml(Reader reader) Deserialize an object from a Reader.
static Object	fromXml(String str) Deserialize an object from a String.
static String	getAttributeValueIgnorePrefix(Element element, String attributeName) get attribute value ignoring prefix in attribute name
static DOMImplementationLS	getDomLsImplementation() Returns a DOMImplementationLS instance.
static String	getNodeNameIgnorePrefix(Node node) get node name without any prefix
static String	getTagNameIgnorePrefix(Element element) get tag name without any prefix
static Document	makeEmptyXmlDocument()
static Document	makeEmptyXmlDocument(String rootElementName)
static String	nodeNameToJavaName(String nodeName, boolean capitalizeFirst)
static String	nodeValue(Node node) Return the text (node value) of the first node under this
static Document	readXmlDocument(InputStream is, boolean validate, String docDescription)
static Document	readXmlDocument(InputStream is, boolean validate, String docDescription, boolean withPosition)
static Document	readXmlDocument(InputStream is, String docDescription)
static Document	readXmlDocument(InputStream is, String docDescription, boolean withPosition)
static Document	readXmlDocument(String content)
static Document	readXmlDocument(String content, boolean validate)
static Document	readXmlDocument(String content, boolean validate, boolean withPosition)
static Document	readXmlDocument(URL url)
static Document	readXmlDocument(URL url, boolean validate)
static Document	readXmlDocument(URL url, boolean validate, boolean withPosition)
static String	toXml(Object obj) Serialize an object to an XML String.
static void	toXml(Object obj, OutputStream output) Serialize an object to an OutputStream.
static void	toXml(Object obj, Writer writer) Serialize an object to a Writer.
static void	transformDomDocument(Transformer transformer, Node node, OutputStream os) Serializes a DOM Node to an OutputStream using JAXP TrAX.
static String	writeXmlDocument(Node node)
static void	writeXmlDocument(Node node, OutputStream os, String encoding, boolean omitXmlDeclaration, boolean indent, int indentAmount) Serializes a DOM Node to an OutputStream using JAXP TrAX.
static void	writeXmlDocument(OutputStream os, Node node)
static void	writeXmlDocument(OutputStream os, Node node, String encoding, boolean includeXmlDeclaration, boolean enablePrettyPrint) Serializes a DOM Node to an OutputStream using DOM 3.
static void	writeXmlDocument(String filename, Node node)

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final String module

Method Detail

getDomLsImplementation

public static DOMImplementationLS getDomLsImplementation()
                                                  throws ClassCastException,
                                                         ClassNotFoundException,
                                                         InstantiationException,
                                                         IllegalAccessException

Returns a DOMImplementationLS instance.

Returns:

A DOMImplementationLS instance

Throws:

ClassCastException

ClassNotFoundException

InstantiationException

IllegalAccessException

See Also:

DOM Level 3 Load and Save Specification

createLSOutput

public static LSOutput createLSOutput(DOMImplementationLS impl,
                                      OutputStream os,
                                      String encoding)

Returns a LSOutput instance.

Parameters:

impl - A DOMImplementationLS instance

os - Optional OutputStream instance

encoding - Optional character encoding, default is UTF-8

Returns:

A LSOutput instance

See Also:

DOM Level 3 Load and Save Specification

createLSSerializer

public static LSSerializer createLSSerializer(DOMImplementationLS impl,
                                              boolean includeXmlDeclaration,
                                              boolean enablePrettyPrint)

Returns a LSSerializer instance.

Parameters:

impl - A DOMImplementationLS instance

includeXmlDeclaration - If set to true, the xml declaration will be included in the output

enablePrettyPrint - If set to true, the output will be formatted in human-readable form. If set to false, the entire document will consist of a single line.

Returns:

A LSSerializer instance

See Also:

DOM Level 3 Load and Save Specification

writeXmlDocument

public static void writeXmlDocument(OutputStream os,
                                    Node node,
                                    String encoding,
                                    boolean includeXmlDeclaration,
                                    boolean enablePrettyPrint)
                             throws ClassCastException,
                                    ClassNotFoundException,
                                    InstantiationException,
                                    IllegalAccessException

Serializes a DOM Node to an OutputStream using DOM 3.

Parameters:

os - The OutputStream instance to write to

node - The DOM Node object to be serialized

encoding - Optional character encoding

includeXmlDeclaration - If set to true, the xml declaration will be included in the output

enablePrettyPrint - If set to true, the output will be formatted in human-readable form. If set to false, the entire document will consist of a single line.

Throws:

ClassCastException

ClassNotFoundException

InstantiationException

IllegalAccessException

See Also:

DOM Level 3 Load and Save Specification

createOutputTransformer

public static Transformer createOutputTransformer(String encoding,
                                                  boolean omitXmlDeclaration,
                                                  boolean indent,
                                                  int indentAmount)
                                           throws TransformerConfigurationException

Creates a JAXP TrAX Transformer suitable for pretty-printing an XML document. This method is provided as an alternative to the deprecated org.apache.xml.serialize.OutputFormat class.

Parameters:

encoding - Optional encoding, defaults to UTF-8

omitXmlDeclaration - If true the xml declaration will be omitted from the output

indent - If true, the output will be indented

indentAmount - If indent is true, the number of spaces to indent. Default is 4.

Returns:

A Transformer instance

Throws:

TransformerConfigurationException

See Also:

JAXP TrAX

transformDomDocument

public static void transformDomDocument(Transformer transformer,
                                        Node node,
                                        OutputStream os)
                                 throws TransformerException

Serializes a DOM Node to an OutputStream using JAXP TrAX.

Parameters:

transformer - A Transformer instance

node - The Node to serialize

os - The OutputStream to serialize to

Throws:

TransformerException

See Also:

JAXP TrAX

writeXmlDocument

public static void writeXmlDocument(Node node,
                                    OutputStream os,
                                    String encoding,
                                    boolean omitXmlDeclaration,
                                    boolean indent,
                                    int indentAmount)
                             throws TransformerException

Serializes a DOM Node to an OutputStream using JAXP TrAX.

Parameters:

node - The Node to serialize

os - The OutputStream to serialize to

encoding - Optional encoding, defaults to UTF-8

omitXmlDeclaration - If true the xml declaration will be omitted from the output

indent - If true, the output will be indented

indentAmount - If indent is true, the number of spaces to indent. Default is 4.

Throws:

TransformerException

See Also:

JAXP TrAX

fromXml

public static Object fromXml(InputStream input)

Deserialize an object from an InputStream.

Parameters:

input - The InputStream

Returns:

The deserialized Object

fromXml

public static Object fromXml(Reader reader)

Deserialize an object from a Reader.

Parameters:

reader - The Reader

Returns:

The deserialized Object

fromXml

public static Object fromXml(String str)

Deserialize an object from a String.

Parameters:

str - The String

Returns:

The deserialized Object

toXml

public static String toXml(Object obj)

Serialize an object to an XML String.

Parameters:

obj - The object to serialize

Returns:

An XML String

toXml

public static void toXml(Object obj,
                         OutputStream output)

Serialize an object to an OutputStream.

Parameters:

obj - The object to serialize

output - The OutputStream

toXml

public static void toXml(Object obj,
                         Writer writer)

Serialize an object to a Writer.

Parameters:

obj - The object to serialize

writer - The Writer

writeXmlDocument

public static String writeXmlDocument(Node node)
                               throws IOException

Throws:

IOException

writeXmlDocument

public static void writeXmlDocument(String filename,
                                    Node node)
                             throws FileNotFoundException,
                                    IOException

Throws:

FileNotFoundException

IOException

writeXmlDocument

public static void writeXmlDocument(OutputStream os,
                                    Node node)
                             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(String content,
                                       boolean validate,
                                       boolean withPosition)
                                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(URL url,
                                       boolean validate,
                                       boolean withPosition)
                                throws SAXException,
                                       ParserConfigurationException,
                                       IOException

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

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

Throws:

SAXException

ParserConfigurationException

IOException

readXmlDocument

public static Document readXmlDocument(InputStream is,
                                       String docDescription,
                                       boolean withPosition)
                                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

readXmlDocument

public static Document readXmlDocument(InputStream is,
                                       boolean validate,
                                       String docDescription,
                                       boolean withPosition)
                                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.

addChildElementNSElement

public static Element addChildElementNSElement(Element element,
                                               String childElementName,
                                               Document document,
                                               String nameSpaceUrl)

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

addChildElementNSValue

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

Creates a child element with the given namespace supportive 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<? extends Element> childElementList(Element element)

Return a List of Element objects that are children of the given element

childElementList

public static List<? extends 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.

childElementList

public static List<? extends Element> childElementList(Element element,
                                                       Set<String> childElementNames)

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.

childElementList

public static List<? extends Element> childElementList(Element element,
                                                       String... childElementNames)

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.

childElementList

public static List<? extends Element> childElementList(DocumentFragment fragment)

Return a List of Element objects that are children of the given DocumentFragment

childNodeList

public static List<? extends Node> childNodeList(Node node)

Return a List of Node 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,
                                        Set<String> childElementNames)

Return the first child Element returns the first element.

firstChildElement

public static Element firstChildElement(Element element,
                                        String... childElementNames)

Return the first child Element returns the first element.

firstChildElement

public static Element firstChildElement(Element element)

Return the first child Element returns the first element.

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.

childElementAttribute

public static String childElementAttribute(Element element,
                                           String childElementName,
                                           String attributeName,
                                           String defaultValue)

Return a named attribute of a named child node or a default if null.

elementValue

public static String elementValue(Element element)

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

nodeValue

public static String nodeValue(Node node)

Return the text (node value) of the first node under this

elementAttribute

public static String elementAttribute(Element element,
                                      String attrName,
                                      String defaultValue)

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)

nodeNameToJavaName

public static String nodeNameToJavaName(String nodeName,
                                        boolean capitalizeFirst)

getNodeNameIgnorePrefix

public static String getNodeNameIgnorePrefix(Node node)

get node name without any prefix

Parameters:

node -

Returns:

nodeName

getTagNameIgnorePrefix

public static String getTagNameIgnorePrefix(Element element)

get tag name without any prefix

Parameters:

element -

Returns:

tagName

getAttributeValueIgnorePrefix

public static String getAttributeValueIgnorePrefix(Element element,
                                                   String attributeName)

get attribute value ignoring prefix in attribute name

Parameters:

element -

Returns:

The value of the node, depending on its type; see the table Node class