com.sun.jbi.management.internal.support

Class DOMUtil

java.lang.Object

com.sun.jbi.management.internal.support.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 String	NS_URI_XMLNS The namespaceURI represented by the prefix xmlns.
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
static boolean	areElementsEqual(File file1, File file2, String xpathExp) This method is used to check if the value of the an element is same in the both of the documents provided.
String	DOM2String(Document aDocument, Writer aWriter) save document to stream.
String	elementToString(Element element) Convert an element to String
String	getAttribute(Element aElement, String aAttribute) get attribute
String	getAttribute(Element aElement, String aAttribute, String aPrefix) get attribute
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) gets the 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	getLocalName(String qname) Gets the local name from the quname.
String	getName(String aName) strips the prefix of the name if present.
String	getName(String aName, String aPrefix) adds the prefix to the name
String	getNamespace(Element el, String qname) Gets the namespace from the qname.
QName	getQualifiedAttributeValue(Element el, String attrName) use this util method to retrieve a QName in a attribute.
String	getTextData(Element aElement) use this util method to retrieve a Text Data in a element.
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.

NS_URI_XMLNS

public static final String NS_URI_XMLNS

The namespaceURI represented by the prefix xmlns.

See Also:

Constant Field Values

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)

gets the element.

Parameters:

elem - Element for parent node

tagName - String for tagname

Returns:

Element with tagname

getElementValue

public String getElementValue(Document doc,
                     String elemName)

gets the element value.

Parameters:

doc - Document for parent node

elemName - String for element name

Returns:

Element value

getAttribute

public String getAttribute(Element aElement,
                  String aAttribute,
                  String aPrefix)

get attribute

Parameters:

aElement - Element object

aAttribute - String value of attribute

aPrefix - String value of prefix

Returns:

String value of Attr value

getAttribute

public String getAttribute(Element aElement,
                  String aAttribute)

get attribute

Parameters:

aElement - Element object

aAttribute - String value of attribute

Returns:

String value of Attr value

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

getLocalName

public String getLocalName(String qname)

Gets the local name from the quname.

Parameters:

qname - Qualified name of service.

Returns:

String local name

getNamespace

public String getNamespace(Element el,
                  String qname)

Gets the namespace from the qname.

Parameters:

qname - Qname of service

Returns:

namespace namespace of service

getQualifiedAttributeValue

public QName getQualifiedAttributeValue(Element el,
                               String attrName)
                                 throws IllegalArgumentException

use this util method to retrieve a QName in a attribute.

Parameters:

aElement - Element containing the attribute

attrName - attribute name

Throws:

IllegalArgumentException

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:

String representation of Document

Throws:

Exception - If fails to construct a string.

elementToString

public String elementToString(Element element)
                       throws Exception

Convert an element to String

Parameters:

element - - the element to convert to String

Throws:

Exception

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

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

getName

public String getName(String aName,
             String aPrefix)

adds the prefix to the name

Parameters:

aName - String value of Name with prefix

aPrefix - String value of prefix

Returns:

name with prefix prefixed

areElementsEqual

public static boolean areElementsEqual(File file1,
                       File file2,
                       String xpathExp)
                                throws ManagementException

This method is used to check if the value of the an element is same in the both of the documents provided.

Parameters:

file1 - that contains a descriptor

file2 - that contains the other descriptor

elementName - the element name

Returns:

boolean if the elements are equal

Throws:

ManagementException - if there are problems in comparing the documents