com.sun.jbi.ui.common

Class DOMUtil

java.lang.Object

com.sun.jbi.ui.common.DOMUtil

public class DOMUtil
extends Object

This object provides utility methods to manipulate DOM tree

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DOMUtil.NodeListImpl NodeListImpl

Field Summary

Fields

Modifier and Type	Field and Description
static DOMUtil	UTIL static object to access the methods of this object

Constructor Summary

Constructors

Constructor and Description
DOMUtil() Creates a new instance of DOMUtil

Method Summary

Methods

Modifier and Type	Method and Description
Document	buildDOMDocument(Reader xmlReader) return the DOM Document
Document	buildDOMDocument(Reader xmlReader, boolean nsAwareFlag) return the DOM Document
Document	buildDOMDocument(String xmlText) return the DOM Document
String	DOM2String(Document aDocument, Writer aWriter) save document to stream
Element	getChildElement(Element aElement, String aElementTagName) get the child with the specified tag name
NodeList	getChildElements(Element aElement, String aElementTagName) get the children of the same type element tag name
Element	getElement(Document aParentDocument, String aTagName) gets the element
Element	getElement(Element elem, String tagName) get the child element
String	getElementName(Element aElement) get Element Tag Name with striped prefix.
NodeList	getElements(Document aParentDocument, String aTagName) gets set of elements
NodeList	getElements(Element aParentElement, String aTagName) gets list of elements
String	getElementValue(Document doc, String elemName) gets the element value
String	getName(String aName) strips the prefix of the name if present
String	getTextData(Element aElement) use this util method to retrieve a Text Data in a element
static String	replaceXmlEntityReferecesToEscapeChars(String xmlString) replaces the xml entity refereces with the xml escape chars
static String	replaceXmlEscapeCharsToEntityRefereces(String xmlString) replaces the xml entity refereces with the xml escape chars
void	setTextData(Element aElement, String aData) use this util method to set a Text Data in a element

Methods inherited from class java.lang.Object

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

Field Detail

UTIL

public static final DOMUtil UTIL

static object to access the methods of this object

Constructor Detail

DOMUtil

public DOMUtil()

Creates a new instance of DOMUtil

Method Detail

getElement

public Element getElement(Document aParentDocument,
                 String aTagName)

gets the element

Parameters:

aParentDocument - Document for parent node

aTagName - String for tagname

Returns:

Element with tagname

getElement

public Element getElement(Element elem,
                 String tagName)

get the child element

Parameters:

elem - parent element

tagName - element to look for

Returns:

child element of type tagName

getElementValue

public String getElementValue(Document doc,
                     String elemName)

gets the element value

Parameters:

doc - document

elemName - element

Returns:

value of the element

setTextData

public void setTextData(Element aElement,
               String aData)

use this util method to set a Text Data in a element

Parameters:

aElement - Element for text node

aData - String contains text

getTextData

public String getTextData(Element aElement)

use this util method to retrieve a Text Data in a element

Parameters:

aElement - Element for text node

Returns:

String contains text

DOM2String

public String DOM2String(Document aDocument,
                Writer aWriter)
                  throws Exception

save document to stream

Parameters:

aDocument - Document

aWriter - is what the aDocument is serialized to.

Returns:

xml text

Throws:

Exception - on error

getElements

public NodeList getElements(Element aParentElement,
                   String aTagName)

gets list of elements

Parameters:

aParentElement - Element for parent

aTagName - String for tagname

Returns:

NodeList with tagname

getElements

public NodeList getElements(Document aParentDocument,
                   String aTagName)

gets set of elements

Parameters:

aParentDocument - Document for parent node

aTagName - String for tagname

Returns:

NodeList with tagname

getChildElements

public NodeList getChildElements(Element aElement,
                        String aElementTagName)

get the children of the same type element tag name

Parameters:

aElement - Element for parent node

aElementTagName - String for tagname

Returns:

NodeList for list of children with the tagname

getChildElement

public Element getChildElement(Element aElement,
                      String aElementTagName)

get the child with the specified tag name

Parameters:

aElement - Element for parent node

aElementTagName - String for tagname

Returns:

NodeList for list of children with the tagname

getElementName

public String getElementName(Element aElement)

get Element Tag Name with striped prefix.

Parameters:

aElement - Element object

Returns:

String with stripped prefix

getName

public String getName(String aName)

strips the prefix of the name if present

Parameters:

aName - String value of Name with prefix

Returns:

String for name after striping prefix

buildDOMDocument

public Document buildDOMDocument(String xmlText)
                          throws Exception

return the DOM Document

Parameters:

xmlText - String

Returns:

dom document

Throws:

Exception - on parser exception or any other exception

buildDOMDocument

public Document buildDOMDocument(Reader xmlReader)
                          throws Exception

return the DOM Document

Parameters:

xmlReader - Reader

Returns:

dom document

Throws:

Exception - on parser exception or any other exception

buildDOMDocument

public Document buildDOMDocument(Reader xmlReader,
                        boolean nsAwareFlag)
                          throws Exception

return the DOM Document

Parameters:

xmlReader - Reader

nsAwareFlag - indicating whether it is namespace awareness or not

Returns:

dom document

Throws:

Exception - on parser exception or any other exception

replaceXmlEscapeCharsToEntityRefereces

public static String replaceXmlEscapeCharsToEntityRefereces(String xmlString)

replaces the xml entity refereces with the xml escape chars

Parameters:

xmlString - Text with the xml xml escape chars

Text - with the xml entity refereces

replaceXmlEntityReferecesToEscapeChars

public static String replaceXmlEntityReferecesToEscapeChars(String xmlString)

replaces the xml entity refereces with the xml escape chars

Parameters:

xmlString - Text with the xml entity references

Text - with the xml escape chars