Package com.ca.apim.gateway.cagatewayexport.util.xml

Class DocumentUtils

java.lang.Object

com.ca.apim.gateway.cagatewayexport.util.xml.DocumentUtils

public class DocumentUtils
extends java.lang.Object

Utility methods to handle xml document elements.

Method Summary

Modifier and Type	Method	Description
static org.w3c.dom.Element	buildPropertiesElement(java.util.Map<java.lang.String,java.lang.Object> properties, org.w3c.dom.Document document, java.lang.String propertiesElementName)
static org.w3c.dom.Element	createElementWithAttribute(org.w3c.dom.Document document, java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue)
static org.w3c.dom.Element	createElementWithAttributes(org.w3c.dom.Document document, java.lang.String elementName, java.util.Map<java.lang.String,java.lang.String> attributes)
static org.w3c.dom.Element	createElementWithAttributesAndChildren(org.w3c.dom.Document document, java.lang.String elementName, java.util.Map<java.lang.String,java.lang.String> attributes, org.w3c.dom.Element... children)
static org.w3c.dom.Element	createElementWithChildren(org.w3c.dom.Document document, java.lang.String elementName, org.w3c.dom.Element... children)
static org.w3c.dom.Element	createElementWithTextContent(org.w3c.dom.Document document, java.lang.String elementName, java.lang.Object textContent)
static java.util.List<org.w3c.dom.Element>	getChildElements(org.w3c.dom.Element entityItemElement, java.lang.String elementName)	Search in the children of the element specified all elements with the name specified .
static java.util.List<java.lang.String>	getChildElementsAttributeValues(org.w3c.dom.Element entityItemElement, java.lang.String elementName, java.lang.String attribute)	Search in the children of the element specified all elements with the name specified and returns the specified attribute from all of them.
static java.util.Set<java.lang.String>	getChildElementsTextContents(org.w3c.dom.Element entityItemElement, java.lang.String elementName)	Search in the children of the element specified all elements with the name specified and returns text contents from all of them.
static org.w3c.dom.Element	getSingleChildElement(org.w3c.dom.Element entityItemElement, java.lang.String elementName)	Search in the children of the element specified a single element with the name specified.
static org.w3c.dom.Element	getSingleChildElement(org.w3c.dom.Element entityItemElement, java.lang.String elementName, boolean optional)	Search in the children of the element specified a single element with the name specified .
static java.lang.String	getSingleChildElementAttribute(org.w3c.dom.Element entityItemElement, java.lang.String elementName, java.lang.String attributeName)	Search in the children of the element specified a single element with the name specified and returns the value from the attribute specified.
static java.lang.String	getSingleChildElementTextContent(org.w3c.dom.Element entityItemElement, java.lang.String elementName)	Search in the children of the element specified a single element with the name specified and returns its text content.
static org.w3c.dom.Element	getSingleElement(org.w3c.dom.Element entityItemElement, java.lang.String entityName)	Search in the children of the element specified a single element with the name specified.
static org.w3c.dom.Element	stringToXML(DocumentTools documentTools, java.lang.String string)	Generate dom Element from a XML String.

Methods inherited from class java.lang.Object

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

Method Detail

stringToXML

public static org.w3c.dom.Element stringToXML(DocumentTools documentTools,
                                              java.lang.String string)
                                       throws DocumentParseException

Generate dom Element from a XML String.

Parameters:

documentTools - DocumentTools instance used for parsing

string - xml String

Returns:

Xml Element

Throws:

DocumentParseException - if any errors

getSingleElement

public static org.w3c.dom.Element getSingleElement(org.w3c.dom.Element entityItemElement,
                                                   java.lang.String entityName)

Search in the children of the element specified a single element with the name specified.

Parameters:

entityItemElement - element to search into

entityName - element name to search

Returns:

a single element found

Throws:

BundleBuilderException - if not found, multiple found or invalid node type found (not element)

getSingleChildElement

public static org.w3c.dom.Element getSingleChildElement(org.w3c.dom.Element entityItemElement,
                                                        java.lang.String elementName)

Search in the children of the element specified a single element with the name specified.

Parameters:

entityItemElement - element to search into

elementName - element name to search

Returns:

a single element found

Throws:

BundleBuilderException - if not found, multiple found or invalid node type found (not element)

getSingleChildElement

public static org.w3c.dom.Element getSingleChildElement(org.w3c.dom.Element entityItemElement,
                                                        java.lang.String elementName,
                                                        boolean optional)

Search in the children of the element specified a single element with the name specified .

Parameters:

entityItemElement - element to search into

elementName - element name to search

optional - if not found returns null instead of throwing exception

Returns:

a single element found

Throws:

BundleBuilderException - if multiple found or invalid node type found (not element)

getSingleChildElementTextContent

public static java.lang.String getSingleChildElementTextContent(org.w3c.dom.Element entityItemElement,
                                                                java.lang.String elementName)

Search in the children of the element specified a single element with the name specified and returns its text content.

Parameters:

entityItemElement - element to search into

elementName - element name to search

Returns:

text content from a single element found

Throws:

BundleBuilderException - if multiple found or invalid node type found (not element)

getSingleChildElementAttribute

public static java.lang.String getSingleChildElementAttribute(org.w3c.dom.Element entityItemElement,
                                                              java.lang.String elementName,
                                                              java.lang.String attributeName)

Search in the children of the element specified a single element with the name specified and returns the value from the attribute specified.

Parameters:

entityItemElement - element to search into

elementName - element name to search

attributeName - attribute name to get value

Returns:

value from the attribute found in a single element, null if element is not present or attribute is not present or its value is empty

getChildElements

public static java.util.List<org.w3c.dom.Element> getChildElements(org.w3c.dom.Element entityItemElement,
                                                                   java.lang.String elementName)

Search in the children of the element specified all elements with the name specified .

Parameters:

entityItemElement - element to search into

elementName - element name to search

Returns:

list of elements found, empty if not found any

getChildElementsTextContents

public static java.util.Set<java.lang.String> getChildElementsTextContents(org.w3c.dom.Element entityItemElement,
                                                                           java.lang.String elementName)

Search in the children of the element specified all elements with the name specified and returns text contents from all of them.

Parameters:

entityItemElement - element to search into

elementName - element name to search

Returns:

list of contents from elements found, empty if not found any

getChildElementsAttributeValues

public static java.util.List<java.lang.String> getChildElementsAttributeValues(org.w3c.dom.Element entityItemElement,
                                                                               java.lang.String elementName,
                                                                               java.lang.String attribute)

Search in the children of the element specified all elements with the name specified and returns the specified attribute from all of them.

Parameters:

entityItemElement - element to search into

elementName - element name to search

attribute - attribute to search

Returns:

list of attribute value from elements found, empty if not found any

createElementWithTextContent

public static org.w3c.dom.Element createElementWithTextContent(org.w3c.dom.Document document,
                                                               java.lang.String elementName,
                                                               java.lang.Object textContent)

createElementWithAttribute

public static org.w3c.dom.Element createElementWithAttribute(org.w3c.dom.Document document,
                                                             java.lang.String elementName,
                                                             java.lang.String attributeName,
                                                             java.lang.String attributeValue)

createElementWithAttributes

public static org.w3c.dom.Element createElementWithAttributes(org.w3c.dom.Document document,
                                                              java.lang.String elementName,
                                                              java.util.Map<java.lang.String,java.lang.String> attributes)

createElementWithChildren

public static org.w3c.dom.Element createElementWithChildren(org.w3c.dom.Document document,
                                                            java.lang.String elementName,
                                                            org.w3c.dom.Element... children)

createElementWithAttributesAndChildren

public static org.w3c.dom.Element createElementWithAttributesAndChildren(org.w3c.dom.Document document,
                                                                         java.lang.String elementName,
                                                                         java.util.Map<java.lang.String,java.lang.String> attributes,
                                                                         org.w3c.dom.Element... children)

buildPropertiesElement

public static org.w3c.dom.Element buildPropertiesElement(java.util.Map<java.lang.String,java.lang.Object> properties,
                                                         org.w3c.dom.Document document,
                                                         java.lang.String propertiesElementName)