com.ibm.wsdl.util.xml

Class DOMUtils

public class DOMUtils extends Object

Method Summary
static StringcleanString(String orig)
static intcountKids(Element elem, short nodeType)
Count number of children of a certain type of the given element.
static ElementfindChildElementWithAttribute(Element elem, String attrName, String attrValue)
Return the first child element of the given element which has the given attribute with the given value.
static StringgetAttribute(Element el, String attrName)
Returns the value of an attribute of an element.
static StringgetAttribute(Element el, String attrName, List remainingAttrs)
Returns the value of an attribute of an element.
static StringgetAttributeNS(Element el, String namespaceURI, String localPart)
Returns the value of an attribute of an element.
static ListgetAttributes(Element el)
Returns a list of attributes of an element.
static StringgetChildCharacterData(Element parentEl)
Concat all the text and cdata node children of this elem and return the resulting text.
static ElementgetFirstChildElement(Element elem)
Return the first child element of the given element.
static StringgetNamespaceURIFromPrefix(Node context, String prefix)
Given a prefix and a node, return the namespace URI that the prefix has been associated with.
static ElementgetNextSiblingElement(Element elem)
Return the next sibling element of the given element.
static StringgetPrefix(String namespaceURI, Definition def)
static QNamegetQName(String prefixedValue, Element contextEl, Definition def)
static QNamegetQualifiedAttributeValue(Element el, String attrName, String elDesc, boolean isRequired, Definition def)
This method should be used for elements that support extension attributes because it does not track the remaining attributes to test for unexpected attributes.
static QNamegetQualifiedAttributeValue(Element el, String attrName, String elDesc, boolean isRequired, Definition def, List remainingAttrs)
This method should be used for elements that do not support extension attributes because it tracks the remaining attributes so that eventually any unexpected attributes can be identified.
static StringgetQualifiedValue(String namespaceURI, String localPart, Definition def)
static voidprintAttribute(String name, String value, PrintWriter pw)
static voidprintQualifiedAttribute(QName name, String value, Definition def, PrintWriter pw)
Prints attributes with qualified names.
static voidprintQualifiedAttribute(QName name, QName value, Definition def, PrintWriter pw)
static voidprintQualifiedAttribute(String name, QName value, Definition def, PrintWriter pw)
static voidregisterUniquePrefix(String prefix, String namespaceURI, Definition def)
static voidthrowWSDLException(Element location)
static voidthrowWSDLException(Element location, List remainingAttrs)

Method Detail

cleanString

public static String cleanString(String orig)

countKids

public static int countKids(Element elem, short nodeType)
Count number of children of a certain type of the given element.

Parameters: elem the element whose kids are to be counted

Returns: the number of matching kids.

findChildElementWithAttribute

public static Element findChildElementWithAttribute(Element elem, String attrName, String attrValue)
Return the first child element of the given element which has the given attribute with the given value.

Parameters: elem the element whose children are to be searched attrName the attrib that must be present attrValue the desired value of the attribute

Returns: the first matching child element.

getAttribute

public static String getAttribute(Element el, String attrName)
Returns the value of an attribute of an element. Returns null if the attribute is not found (whereas Element.getAttribute returns "" if an attrib is not found). This method should be used for elements that support extension attributes because it does not track unexpected attributes.

Parameters: el Element whose attrib is looked for attrName name of attribute to look for

Returns: the attribute value

getAttribute

public static String getAttribute(Element el, String attrName, List remainingAttrs)
Returns the value of an attribute of an element. Returns null if the attribute is not found (whereas Element.getAttribute returns "" if an attrib is not found). This method should be used for elements that do not support extension attributes because it tracks the element's remaining attributes so that eventually any unexpected attributes can be identified.

Parameters: el Element whose attrib is looked for attrName name of attribute to look for remainingAttrs List of remaining attributes

Returns: the attribute value

getAttributeNS

public static String getAttributeNS(Element el, String namespaceURI, String localPart)
Returns the value of an attribute of an element. Returns null if the attribute is not found (whereas Element.getAttributeNS returns "" if an attrib is not found).

Parameters: el Element whose attrib is looked for namespaceURI namespace URI of attribute to look for localPart local part of attribute to look for

Returns: the attribute value

getAttributes

public static List getAttributes(Element el)
Returns a list of attributes of an element. Returns an empty list if the element has no attributes. Does not include namespace declarations.

Parameters: el Element whose attributes are returned

Returns: the List of Attr

getChildCharacterData

public static String getChildCharacterData(Element parentEl)
Concat all the text and cdata node children of this elem and return the resulting text.

Parameters: parentEl the element whose cdata/text node values are to be combined.

Returns: the concatanated string.

getFirstChildElement

public static Element getFirstChildElement(Element elem)
Return the first child element of the given element. Null if no children are found.

Parameters: elem Element whose child is to be returned

Returns: the first child element.

getNamespaceURIFromPrefix

public static String getNamespaceURIFromPrefix(Node context, String prefix)
Given a prefix and a node, return the namespace URI that the prefix has been associated with. This method is useful in resolving the namespace URI of attribute values which are being interpreted as QNames. If prefix is null, this method will return the default namespace.

Parameters: context the starting node (looks up recursively from here) prefix the prefix to find an xmlns:prefix=uri for

Returns: the namespace URI or null if not found

getNextSiblingElement

public static Element getNextSiblingElement(Element elem)
Return the next sibling element of the given element. Null if no more sibling elements are found.

Parameters: elem Element whose sibling element is to be returned

Returns: the next sibling element.

getPrefix

public static String getPrefix(String namespaceURI, Definition def)

getQName

public static QName getQName(String prefixedValue, Element contextEl, Definition def)

getQualifiedAttributeValue

public static QName getQualifiedAttributeValue(Element el, String attrName, String elDesc, boolean isRequired, Definition def)
This method should be used for elements that support extension attributes because it does not track the remaining attributes to test for unexpected attributes.

getQualifiedAttributeValue

public static QName getQualifiedAttributeValue(Element el, String attrName, String elDesc, boolean isRequired, Definition def, List remainingAttrs)
This method should be used for elements that do not support extension attributes because it tracks the remaining attributes so that eventually any unexpected attributes can be identified.

getQualifiedValue

public static String getQualifiedValue(String namespaceURI, String localPart, Definition def)

printAttribute

public static void printAttribute(String name, String value, PrintWriter pw)

printQualifiedAttribute

public static void printQualifiedAttribute(QName name, String value, Definition def, PrintWriter pw)
Prints attributes with qualified names.

printQualifiedAttribute

public static void printQualifiedAttribute(QName name, QName value, Definition def, PrintWriter pw)

printQualifiedAttribute

public static void printQualifiedAttribute(String name, QName value, Definition def, PrintWriter pw)

registerUniquePrefix

public static void registerUniquePrefix(String prefix, String namespaceURI, Definition def)

throwWSDLException

public static void throwWSDLException(Element location)

throwWSDLException

public static void throwWSDLException(Element location, List remainingAttrs)
Copyright © 2003,2005 IBM. All Rights Reserved.