de.innovationgate.wga.server.api

Class Xml

java.lang.Object

de.innovationgate.wga.server.api.Xml

public class Xml
extends java.lang.Object

Object "Xml" collects functionalities to load and parse Xml documents. OpenwGA uses the Java XML Parser Dom4J to parse and process XML documents.

Method Summary

Methods

Modifier and Type	Method and Description
org.dom4j.Document	create() Creates a new empty DOM document
org.dom4j.Document	load(org.apache.commons.httpclient.HttpClient client, java.lang.String url) Loads an XML document from a URL and parses it as DOM document
org.dom4j.Document	load(java.lang.String url) Loads an XML document from a URL and parses it as DOM document
org.dom4j.Document	parse(java.lang.String xml) Parses XML text and returns a DOM document object for it
org.dom4j.Document	parse(java.lang.String xml, java.lang.String systemId) Parses XML text and returns a DOM document object for it
java.lang.Object	xpath(java.lang.Object object, java.lang.String xpath) Executes an XPath expression on some XML text or JavaBean This function always returns single values.
java.lang.Object	xpath(java.lang.Object object, java.lang.String xpath, java.util.Map<java.lang.String,java.lang.String> ns) Executes an XPath expression on some XML text or JavaBean This function always returns single values.
java.lang.Object	xpathList(java.lang.Object object, java.lang.String xpath) Executes an XPath expression on some XML text or JavaBean This function always returns lists.
java.lang.Object	xpathList(java.lang.Object object, java.lang.String xpath, java.util.Map<java.lang.String,java.lang.String> ns) Executes an XPath expression on some XML text or JavaBean This function always returns lists.

Methods inherited from class java.lang.Object

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

Method Detail

create

public org.dom4j.Document create()
                          throws de.innovationgate.webgate.api.WGException

Creates a new empty DOM document

Throws:

de.innovationgate.webgate.api.WGException

parse

public org.dom4j.Document parse(java.lang.String xml,
                       java.lang.String systemId)
                         throws de.innovationgate.webgate.api.WGException,
                                org.dom4j.DocumentException

Parses XML text and returns a DOM document object for it

Parameters:

xml - The xml

systemId - An URL which should be used to resolve relative references in the XML text, like a DOCTYPE reference.

Returns:

DOM document of parsed XML data

Throws:

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

parse

public org.dom4j.Document parse(java.lang.String xml)
                         throws de.innovationgate.webgate.api.WGException,
                                org.dom4j.DocumentException

Parses XML text and returns a DOM document object for it

Parameters:

xml - The xml

Returns:

DOM document of parsed XML data

Throws:

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

xpath

public java.lang.Object xpath(java.lang.Object object,
                     java.lang.String xpath)
                       throws de.innovationgate.webgate.api.WGException,
                              org.dom4j.DocumentException

Executes an XPath expression on some XML text or JavaBean This function always returns single values. If the xpath expression matches multiple values it will only return the first one. To retrieve lists of values use xpathList(Object, String). The given object to parse as XML is either a dom4j branch object (mostly document or element), a String containing XML text or a JavaBean. In the last case this function uses JXPath functionality to find a bean property value. This uses the Apache library JXPath under the hood. See their documentation for details how XPath is used to browser JavaBeans.

Parameters:

object - Object to inspect

xpath - XPath expression

Returns:

Returned value

Throws:

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

xpath

public java.lang.Object xpath(java.lang.Object object,
                     java.lang.String xpath,
                     java.util.Map<java.lang.String,java.lang.String> ns)
                       throws de.innovationgate.webgate.api.WGException,
                              org.dom4j.DocumentException

Executes an XPath expression on some XML text or JavaBean This function always returns single values. If the xpath expression matches multiple values it will only return the first one. To retrieve lists of values use xpathList(Object, String). The given object to parse as XML is either a dom4j branch object (mostly document or element), a String containing XML text or a JavaBean. In the last case this function uses JXPath functionality to find a bean property value. This uses the Apache library JXPath under the hood. See their documentation for details how XPath is used to browser JavaBeans.

Parameters:

object - Object to inspect

xpath - XPath expression

ns - Map of namespace prefix declarations used in the XPath. Keys are prefixes, values are namespace URIs.

Returns:

Returned value

Throws:

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

xpathList

public java.lang.Object xpathList(java.lang.Object object,
                         java.lang.String xpath)
                           throws de.innovationgate.webgate.api.WGException,
                                  org.dom4j.DocumentException

Executes an XPath expression on some XML text or JavaBean This function always returns lists. If the xpath expression matches only a single values it will return it as single element in a list. If you only want to retrieve single values use xpath(). The given object to parse as XML is either a dom4j branch object (mostly document or element), a String containing XML text or a JavaBean. In the last case this function uses JXPath functionality to find a bean property value. This uses the Apache library JXPath under the hood. See their documentation for details how XPath is used to browser JavaBeans.

Parameters:

object - Object to inspect

xpath - XPath expression

Returns:

Returned value

Throws:

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

xpathList

public java.lang.Object xpathList(java.lang.Object object,
                         java.lang.String xpath,
                         java.util.Map<java.lang.String,java.lang.String> ns)
                           throws de.innovationgate.webgate.api.WGException,
                                  org.dom4j.DocumentException

Executes an XPath expression on some XML text or JavaBean This function always returns lists. If the xpath expression matches only a single values it will return it as single element in a list. If you only want to retrieve single values use xpath(). The given object to parse as XML is either a dom4j branch object (mostly document or element), a String containing XML text or a JavaBean. In the last case this function uses JXPath functionality to find a bean property value. This uses the Apache library JXPath under the hood. See their documentation for details how XPath is used to browser JavaBeans.

Parameters:

object - Object to inspect

xpath - XPath expression

ns - Map of namespace prefix declarations used in the XPath. Keys are prefixes, values are namespace URIs.

Returns:

Returned value

Throws:

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

load

public org.dom4j.Document load(java.lang.String url)
                        throws de.innovationgate.webgate.api.WGException,
                               java.io.UnsupportedEncodingException,
                               java.io.IOException,
                               org.apache.commons.httpclient.HttpException,
                               org.xml.sax.SAXException,
                               org.dom4j.DocumentException

Loads an XML document from a URL and parses it as DOM document

Parameters:

url - URL to the XML document

Returns:

DOM document

Throws:

java.io.UnsupportedEncodingException

de.innovationgate.webgate.api.WGAPIException

java.io.IOException

org.apache.commons.httpclient.HttpException

org.xml.sax.SAXException

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException

load

public org.dom4j.Document load(org.apache.commons.httpclient.HttpClient client,
                      java.lang.String url)
                        throws java.io.UnsupportedEncodingException,
                               de.innovationgate.webgate.api.WGException,
                               java.io.IOException,
                               org.apache.commons.httpclient.HttpException,
                               org.xml.sax.SAXException,
                               org.dom4j.DocumentException

Loads an XML document from a URL and parses it as DOM document

Parameters:

client - HTTP client object to load the resource on the URL, used to specify various settings regarding this operation. If no client object is passed a default one is used.

url - URL to the XML document

Returns:

DOM document

Throws:

java.io.UnsupportedEncodingException

de.innovationgate.webgate.api.WGAPIException

java.io.IOException

org.apache.commons.httpclient.HttpException

org.xml.sax.SAXException

org.dom4j.DocumentException

de.innovationgate.webgate.api.WGException