biz.hammurapi.xml.dom
Class DOMUtils

java.lang.Object
  extended by biz.hammurapi.xml.dom.DOMUtils

public class DOMUtils
extends java.lang.Object

Utility class for querying DOM.

Author:
Pavel Vlasov

Method Summary
static java.util.Properties dom2Properties(org.w3c.dom.Element e, java.lang.String prefix)
           
static java.lang.String eval(java.lang.Object item, java.lang.String str)
           
static java.lang.Object eval(java.lang.Object item, java.lang.String str, javax.xml.namespace.QName returnType)
           
static java.lang.String getElementText(org.w3c.dom.Element e)
           
static java.lang.String getNonBlankElementText(org.w3c.dom.Element e)
           
static org.w3c.dom.Element getSingleElement(org.w3c.dom.Element e, java.lang.String elementName)
          Ensures that thre is one and only one element and returns it.
static java.lang.String getSingleElementText(org.w3c.dom.Element e, java.lang.String elementName)
          Ensures that there is only one element and returns its text
static java.lang.String getSingleNonBlankElementText(org.w3c.dom.Element e, java.lang.String elementName)
           
static org.w3c.dom.Document parse(java.io.File file)
           
static org.w3c.dom.Document parse(java.io.InputStream is)
           
static org.w3c.dom.Document parse(java.io.Reader is)
           
static void readProperties(org.w3c.dom.Element holder, java.util.Properties properties)
          Reads elements <property name="...">...</property> into properties
static org.w3c.dom.NodeList selectNodeList(org.w3c.dom.Node contextNode, java.lang.String str)
           
static org.w3c.dom.Node selectSingleNode(org.w3c.dom.Node contextNode, java.lang.String str)
           
static void serialize(org.w3c.dom.Node node, java.io.File out)
           
static void serialize(org.w3c.dom.Node node, java.io.OutputStream os)
           
static void serialize(org.w3c.dom.Node node, java.io.Writer w)
           
static void serialize(java.lang.Object o, java.lang.String root, java.io.File out)
           
static void serialize(java.lang.Object o, java.lang.String root, javax.xml.transform.Result result)
           
static void style(org.w3c.dom.Document doc, java.io.File out, java.io.InputStream style, java.util.Map parameters)
           
static void style(org.w3c.dom.Document doc, java.io.OutputStream os, java.io.InputStream style, java.util.Map parameters)
           
static void style(java.lang.Object o, java.lang.String root, java.io.File out, java.io.InputStream style, java.util.Map parameters)
           
static void style(java.lang.Object o, java.lang.String root, java.io.OutputStream os, java.io.InputStream style, java.util.Map parameters)
           
static org.w3c.dom.Document toDom(java.lang.Object o)
           
static org.w3c.dom.Document toDom(java.lang.Object o, CompositeDomSerializer domSerializer)
           
static void toDom(java.lang.Object o, org.w3c.dom.Element holder)
          Serializes object to XML.
static void toDom(java.lang.Object o, org.w3c.dom.Element holder, CompositeDomSerializer domSerializer)
          Serializes object to XML.
static void toDom(java.lang.Object o, java.lang.String name, org.w3c.dom.Element parent)
          Serializes object to XML.
static void toDom(java.lang.Object o, java.lang.String name, org.w3c.dom.Element parent, CompositeDomSerializer domSerializer)
          Serializes object to XML.
static java.lang.String toString(org.w3c.dom.Node node)
           
static java.lang.String toXmlString(java.lang.Object o, java.lang.String root)
           
static java.lang.String toXmlString(java.lang.Object o, java.lang.String root, CompositeDomSerializer domSerializer)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSingleElement

public static org.w3c.dom.Element getSingleElement(org.w3c.dom.Element e,
                                                   java.lang.String elementName)
                                            throws ConfigurationException,
                                                   javax.xml.xpath.XPathExpressionException
Ensures that thre is one and only one element and returns it.

Throws:
javax.xml.xpath.XPathExpressionException
ConfigurationException

getSingleElementText

public static java.lang.String getSingleElementText(org.w3c.dom.Element e,
                                                    java.lang.String elementName)
                                             throws ConfigurationException,
                                                    javax.xml.xpath.XPathExpressionException
Ensures that there is only one element and returns its text

Throws:
javax.xml.transform.TransformerException
javax.xml.xpath.XPathExpressionException
javax.xml.transform.TransformerException
ConfigurationException

getSingleNonBlankElementText

public static java.lang.String getSingleNonBlankElementText(org.w3c.dom.Element e,
                                                            java.lang.String elementName)
                                                     throws ConfigurationException,
                                                            javax.xml.xpath.XPathExpressionException
Throws:
ConfigurationException
javax.xml.xpath.XPathExpressionException

getElementText

public static java.lang.String getElementText(org.w3c.dom.Element e)
                                       throws javax.xml.xpath.XPathExpressionException
Throws:
javax.xml.xpath.XPathExpressionException

getNonBlankElementText

public static java.lang.String getNonBlankElementText(org.w3c.dom.Element e)
                                               throws ConfigurationException,
                                                      javax.xml.xpath.XPathExpressionException
Throws:
ConfigurationException
javax.xml.xpath.XPathExpressionException

dom2Properties

public static java.util.Properties dom2Properties(org.w3c.dom.Element e,
                                                  java.lang.String prefix)
                                           throws javax.xml.xpath.XPathExpressionException
Throws:
javax.xml.xpath.XPathExpressionException

readProperties

public static void readProperties(org.w3c.dom.Element holder,
                                  java.util.Properties properties)
                           throws ConfigurationException,
                                  javax.xml.xpath.XPathExpressionException
Reads elements <property name="...">...</property> into properties

Throws:
javax.xml.xpath.XPathExpressionException
ConfigurationException

serialize

public static void serialize(java.lang.Object o,
                             java.lang.String root,
                             javax.xml.transform.Result result)
                      throws javax.xml.parsers.ParserConfigurationException,
                             javax.xml.parsers.FactoryConfigurationError,
                             javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError
javax.xml.transform.TransformerException

serialize

public static void serialize(java.lang.Object o,
                             java.lang.String root,
                             java.io.File out)
                      throws javax.xml.parsers.ParserConfigurationException,
                             javax.xml.parsers.FactoryConfigurationError,
                             java.io.IOException,
                             javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError
java.io.IOException
javax.xml.transform.TransformerException

serialize

public static void serialize(org.w3c.dom.Node node,
                             java.io.File out)
                      throws java.io.IOException,
                             javax.xml.transform.TransformerException
Throws:
java.io.IOException
javax.xml.transform.TransformerException

serialize

public static void serialize(org.w3c.dom.Node node,
                             java.io.OutputStream os)
                      throws javax.xml.transform.TransformerException
Throws:
javax.xml.transform.TransformerException

serialize

public static void serialize(org.w3c.dom.Node node,
                             java.io.Writer w)
                      throws javax.xml.transform.TransformerException
Throws:
javax.xml.transform.TransformerException

toString

public static java.lang.String toString(org.w3c.dom.Node node)
                                 throws java.io.IOException,
                                        javax.xml.transform.TransformerException
Throws:
java.io.IOException
javax.xml.transform.TransformerException

toXmlString

public static java.lang.String toXmlString(java.lang.Object o,
                                           java.lang.String root)
                                    throws java.io.IOException,
                                           javax.xml.transform.TransformerException,
                                           javax.xml.parsers.ParserConfigurationException,
                                           javax.xml.parsers.FactoryConfigurationError
Throws:
java.io.IOException
javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

toXmlString

public static java.lang.String toXmlString(java.lang.Object o,
                                           java.lang.String root,
                                           CompositeDomSerializer domSerializer)
                                    throws java.io.IOException,
                                           javax.xml.transform.TransformerException,
                                           javax.xml.parsers.ParserConfigurationException,
                                           javax.xml.parsers.FactoryConfigurationError
Throws:
java.io.IOException
javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

style

public static void style(java.lang.Object o,
                         java.lang.String root,
                         java.io.OutputStream os,
                         java.io.InputStream style,
                         java.util.Map parameters)
                  throws javax.xml.parsers.ParserConfigurationException,
                         javax.xml.parsers.FactoryConfigurationError,
                         javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError
javax.xml.transform.TransformerException

style

public static void style(java.lang.Object o,
                         java.lang.String root,
                         java.io.File out,
                         java.io.InputStream style,
                         java.util.Map parameters)
                  throws javax.xml.parsers.ParserConfigurationException,
                         javax.xml.parsers.FactoryConfigurationError,
                         java.io.IOException,
                         javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError
java.io.IOException
javax.xml.transform.TransformerException

style

public static void style(org.w3c.dom.Document doc,
                         java.io.File out,
                         java.io.InputStream style,
                         java.util.Map parameters)
                  throws java.io.IOException,
                         javax.xml.transform.TransformerException
Throws:
java.io.IOException
javax.xml.transform.TransformerException

style

public static void style(org.w3c.dom.Document doc,
                         java.io.OutputStream os,
                         java.io.InputStream style,
                         java.util.Map parameters)
                  throws javax.xml.transform.TransformerException
Throws:
javax.xml.transform.TransformerException

parse

public static org.w3c.dom.Document parse(java.io.File file)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError
Throws:
org.xml.sax.SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

parse

public static org.w3c.dom.Document parse(java.io.InputStream is)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError
Parameters:
is -
Returns:
Throws:
javax.xml.parsers.FactoryConfigurationError
javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException

parse

public static org.w3c.dom.Document parse(java.io.Reader is)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError
Parameters:
is -
Returns:
Throws:
javax.xml.parsers.FactoryConfigurationError
javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException

toDom

public static void toDom(java.lang.Object o,
                         org.w3c.dom.Element holder)
Serializes object to XML. Specially treats collections, maps, arrays and DomSerializable objects.

Parameters:
o -
holder -

toDom

public static void toDom(java.lang.Object o,
                         java.lang.String name,
                         org.w3c.dom.Element parent)
Serializes object to XML. Specially treats collections, maps, arrays and DomSerializable objects.

Parameters:
o -
name - Element name
parent - parent element

toDom

public static org.w3c.dom.Document toDom(java.lang.Object o)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

toDom

public static void toDom(java.lang.Object o,
                         org.w3c.dom.Element holder,
                         CompositeDomSerializer domSerializer)
Serializes object to XML. Specially treats collections, maps, arrays and DomSerializable objects.

Parameters:
o -
holder -

toDom

public static void toDom(java.lang.Object o,
                         java.lang.String name,
                         org.w3c.dom.Element parent,
                         CompositeDomSerializer domSerializer)
Serializes object to XML. Specially treats collections, maps, arrays and DomSerializable objects.

Parameters:
o -
name - Element name
parent - parent element

toDom

public static org.w3c.dom.Document toDom(java.lang.Object o,
                                         CompositeDomSerializer domSerializer)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         javax.xml.parsers.FactoryConfigurationError
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError

eval

public static java.lang.String eval(java.lang.Object item,
                                    java.lang.String str)
                             throws javax.xml.xpath.XPathExpressionException
Throws:
javax.xml.xpath.XPathExpressionException

eval

public static java.lang.Object eval(java.lang.Object item,
                                    java.lang.String str,
                                    javax.xml.namespace.QName returnType)
                             throws javax.xml.xpath.XPathExpressionException
Throws:
javax.xml.xpath.XPathExpressionException

selectNodeList

public static org.w3c.dom.NodeList selectNodeList(org.w3c.dom.Node contextNode,
                                                  java.lang.String str)
                                           throws javax.xml.xpath.XPathExpressionException
Throws:
javax.xml.xpath.XPathExpressionException

selectSingleNode

public static org.w3c.dom.Node selectSingleNode(org.w3c.dom.Node contextNode,
                                                java.lang.String str)
                                         throws javax.xml.xpath.XPathExpressionException
Throws:
javax.xml.xpath.XPathExpressionException


Copyright © 2003 Hammurapi Group. All Rights Reserved.