com.google.enterprise.connector.util

Class XmlParseUtil

java.lang.Object

com.google.enterprise.connector.util.XmlParseUtil

public class XmlParseUtil
extends java.lang.Object

Utility functions for parsing XML.

Since:

2.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlParseUtil.LocalEntityResolver An EntityResolver implementation that resolves entities using a selection of locally stored DTDs.
static class	XmlParseUtil.ThrowingErrorHandler A simple ErrorHandler implementation that always throws the SAXParseException.

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.String>	getAllAttributes(org.w3c.dom.Element elem, java.lang.String name) Get the attribute values of a given name/value pair for the first XML org.w3c.dom.Element of given name.
static java.util.List<java.lang.String>	getAllElementsByTagName(org.w3c.dom.Element elem, java.lang.String name) Get a list of all child text Elements of given name directly under a given org.w3c.dom.Element.
static java.lang.String	getCdata(org.w3c.dom.Element elem) Extracts the first CDATA child from the given org.w3c.dom.Element.
static java.lang.String	getFirstAttribute(org.w3c.dom.Element elem, java.lang.String name, java.lang.String attrName) Get the attribute value of a given attribute name for the first XML org.w3c.dom.Element of given name.
static java.lang.String	getFirstElementByTagName(org.w3c.dom.Element elem, java.lang.String name) Get text data of first XML org.w3c.dom.Element of given name.
static java.lang.String	getOptionalElementByTagName(org.w3c.dom.Element elem, java.lang.String name) Get text data of an optional XML org.w3c.dom.Element of given name.
static org.w3c.dom.Document	parse(java.io.InputStream in, SAXParseErrorHandler errorHandler, org.xml.sax.EntityResolver entityResolver) Parse an input stream to a org.w3c.dom.Document.
static org.w3c.dom.Document	parse(java.lang.String fileContent, SAXParseErrorHandler errorHandler, org.xml.sax.EntityResolver entityResolver) Parse an XML String to a org.w3c.dom.Document.
static org.w3c.dom.Element	parseAndGetRootElement(java.io.InputStream in, java.lang.String rootTagName) Get a root org.w3c.dom.Element from an XML input stream.
static org.w3c.dom.Element	parseAndGetRootElement(java.lang.String xmlBody, java.lang.String rootTagName) Get a root org.w3c.dom.Element from the XML request body.
static void	validateXhtml(java.lang.String formSnippet) Parses a form snippet using the XHTML Strict DTD, the appropriate HTML context, and a validating parser.

Methods inherited from class java.lang.Object

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

Method Detail

validateXhtml

public static void validateXhtml(java.lang.String formSnippet)
                          throws java.lang.Exception

Parses a form snippet using the XHTML Strict DTD, the appropriate HTML context, and a validating parser.

Parameters:

formSnippet - the form snippet

Throws:

java.lang.Exception - if an unexpected error occrs

parse

public static org.w3c.dom.Document parse(java.lang.String fileContent,
                                         SAXParseErrorHandler errorHandler,
                                         org.xml.sax.EntityResolver entityResolver)

Parse an XML String to a org.w3c.dom.Document.

Parameters:

fileContent - the XML string

errorHandler - the error handle for SAX parser

entityResolver - the entity resolver to use

Returns:

A result Document object, null on error

parseAndGetRootElement

public static org.w3c.dom.Element parseAndGetRootElement(java.lang.String xmlBody,
                                                         java.lang.String rootTagName)

Get a root org.w3c.dom.Element from the XML request body.

Parameters:

xmlBody - the XML request body as a String

rootTagName - the root Element tag name

Returns:

a result Element object if successful, null on error

parse

public static org.w3c.dom.Document parse(java.io.InputStream in,
                                         SAXParseErrorHandler errorHandler,
                                         org.xml.sax.EntityResolver entityResolver)

Parse an input stream to a org.w3c.dom.Document.

Parameters:

in - the input stream

errorHandler - the error handle for SAX parser

entityResolver - the entity resolver to use

Returns:

a result Document object, null on error

parseAndGetRootElement

public static org.w3c.dom.Element parseAndGetRootElement(java.io.InputStream in,
                                                         java.lang.String rootTagName)

Get a root org.w3c.dom.Element from an XML input stream.

Parameters:

in - the input stream

rootTagName - the root Element tag name

Returns:

a result Element object if successful, null on error

getFirstAttribute

public static java.lang.String getFirstAttribute(org.w3c.dom.Element elem,
                                                 java.lang.String name,
                                                 java.lang.String attrName)

Get the attribute value of a given attribute name for the first XML org.w3c.dom.Element of given name.

Parameters:

elem - the parent XML Element

name - the name of the child text Element

attrName - the attribute name

Returns:

attribute value of named child Element

getAllAttributes

public static java.util.Map<java.lang.String,java.lang.String> getAllAttributes(org.w3c.dom.Element elem,
                                                                                java.lang.String name)

Get the attribute values of a given name/value pair for the first XML org.w3c.dom.Element of given name.

Parameters:

elem - the parent XML Element

name - the name of the child text Element

Returns:

attribute name and value Map of named child Element

getOptionalElementByTagName

public static java.lang.String getOptionalElementByTagName(org.w3c.dom.Element elem,
                                                           java.lang.String name)

Get text data of an optional XML org.w3c.dom.Element of given name.

Note that this differs from getFirstElementByTagName(org.w3c.dom.Element, java.lang.String) in how it handles missing elements vs. empty elements. Specifically, if the named element does not exist, this returns null. However, if the named element does exist, but is empty (<tag></tag> or <tag/>), this returns the empty string. In both cases getFirstElementByTagName would return null.

Parameters:

elem - the parent XML Element

name - the name of the child text Element

Returns:

text data of the named child element. Returns null if the named element does not exist. Returns the empty string if the named element exists, but is empty.

getFirstElementByTagName

public static java.lang.String getFirstElementByTagName(org.w3c.dom.Element elem,
                                                        java.lang.String name)

Get text data of first XML org.w3c.dom.Element of given name.

Parameters:

elem - the parent XML Element

name - the name of the child text Element

Returns:

text data of named child Element

getAllElementsByTagName

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

Get a list of all child text Elements of given name directly under a given org.w3c.dom.Element.

Parameters:

elem - the parent Element

name - the given name of searched child Elements

Returns:

a List of values of those child text Elements

getCdata

public static java.lang.String getCdata(org.w3c.dom.Element elem)

Extracts the first CDATA child from the given org.w3c.dom.Element.

Parameters:

elem - the parent Element

Returns:

the String value of the CDATA section, or null if none found