com.ibm.tivoli.nm.collectors.framework.utils

Class CollectorXMLUtils

java.lang.Object

com.ibm.tivoli.nm.collectors.framework.utils.CollectorXMLUtils

public class CollectorXMLUtils
extends java.lang.Object

Utility class for "converting" data into XML style strings for the collector

Author:

Emlyn Whittick

Constructor Summary

Constructors

Constructor and Description
CollectorXMLUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	flatListToXML(java.util.Collection<?> list, java.lang.String objectTag, java.lang.String surroundingTag) Convert a list of objects (most likely strings) to an XML representation
static javax.xml.parsers.DocumentBuilderFactory	getDocumentBuilder()
static javax.xml.parsers.SAXParser	getSaxParserObj()
static javax.xml.transform.TransformerFactory	getTransFacInstance()
static javax.xml.stream.XMLInputFactory	getXmlInputFactory()
static java.lang.String	mapListToGenericListXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list, java.lang.String itemTag, java.lang.String listTag) Convert a list of maps into an XML representation, mapping each key-value pair in a map to a value within a tag, with the tag name represented by the key.
static java.lang.String	mapListToGenericListXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list, java.lang.String mapTag, java.lang.String itemTag, java.lang.String listTag) Convert a list of maps into an XML representation, mapping each key-value pair in a map to a value within a tag, with the tag name represented by the key.
static java.lang.String	mapListToXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list, java.lang.String objectTag) Convert a list of maps into an XML representation @see mapListToXML(java.util.Collection<java.util.Map<java.lang.String, java.lang.Object>>, java.lang.String)
static java.lang.String	mapListToXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list, java.lang.String objectTag, java.lang.String surroundingTag) Convert a list of maps into an XML representation, mapping each key-value pair in a map to a value within a tag, with the tag name represented by the key.
static java.lang.String	mapToXML(java.util.Map<?,?> map) Convert a map to an XML representation.
static java.lang.String	mapToXML(java.util.Map<?,?> map, boolean nested) Convert a map to an XML representation.
static java.lang.String	surroundWithListTag(java.lang.String tagName, java.lang.Object value) Surround a given string with a list tag <tagName type = 'list'>data</tagName>
static java.lang.String	surroundWithTag(java.lang.String tagName, java.lang.Object value) Surround a given string with an "XML tag" e.g.
static java.lang.String	surroundWithTag(java.lang.String tagName, java.lang.Object value, java.util.Map<java.lang.String,java.lang.String> attributes) Surround a given string with an "XML tag" e.g.
static java.lang.String	topologyTypeToTagName(java.lang.String topologyType) Return the XML tag for the Collector.GetConnections(int, String, String) surrounding tag given a specific connection topology type, such as "Layer1"
static java.lang.Object	xmlToMap(java.lang.String xml) Convert an XML string to a map representation, in the inverse way to mapToXML(Map).

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectorXMLUtils

public CollectorXMLUtils()

Method Detail

flatListToXML

public static java.lang.String flatListToXML(java.util.Collection<?> list,
                                             java.lang.String objectTag,
                                             java.lang.String surroundingTag)

Convert a list of objects (most likely strings) to an XML representation

Parameters:

list - The list to convert

objectTag - The tag to surround each object in the list

surroundingTag - The tag to surround the entire list

Returns:

An XML string representing the list

mapListToGenericListXML

public static java.lang.String mapListToGenericListXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list,
                                                       java.lang.String itemTag,
                                                       java.lang.String listTag)

Convert a list of maps into an XML representation, mapping each key-value pair in a map to a value within a tag, with the tag name represented by the key. This should be in a generic form as understood by the agents, i.e. <listTag type="list"><itemTag> ... map data ... </itemTag>...</listTag>

Parameters:

list - The list to convert

itemTag - The tag to surround each object in the list

listTag - The tag to surround the list itself

Returns:

An XML string representing the list

mapListToGenericListXML

public static java.lang.String mapListToGenericListXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list,
                                                       java.lang.String mapTag,
                                                       java.lang.String itemTag,
                                                       java.lang.String listTag)

Convert a list of maps into an XML representation, mapping each key-value pair in a map to a value within a tag, with the tag name represented by the key. This should be in a generic form as understood by the agents, i.e. <listTag type="list"><itemTag> <mapTag>... map data ...</mapTag> </itemTag>...</listTag>

Parameters:

list - The list to convert

mapTag - The tag to surround each map object

itemTag - The tag to surround each object in the list

listTag - The tag to surround the list itself

Returns:

An XML string representing the list

mapListToXML

public static java.lang.String mapListToXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list,
                                            java.lang.String objectTag)

Convert a list of maps into an XML representation @see mapListToXML(java.util.Collection<java.util.Map<java.lang.String, java.lang.Object>>, java.lang.String)

Parameters:

list - The list to convert

objectTag - The tag to surround each object in the list

Returns:

An XML string representing the list

mapListToXML

public static java.lang.String mapListToXML(java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> list,
                                            java.lang.String objectTag,
                                            java.lang.String surroundingTag)

Convert a list of maps into an XML representation, mapping each key-value pair in a map to a value within a tag, with the tag name represented by the key.

Parameters:

list - The list to convert

objectTag - The tag to surround each object in the list

surroundingTag - A tag to surround the entire list

Returns:

An XML string representing the list

mapToXML

public static java.lang.String mapToXML(java.util.Map<?,?> map)

Convert a map to an XML representation. Where Key -> Value is represented as @{code Value}. If a value is a map, will also recursively convert it to a nested XML structure

Parameters:

map - The map to convert

Returns:

An XML string representing the map

mapToXML

public static java.lang.String mapToXML(java.util.Map<?,?> map,
                                        boolean nested)

Convert a map to an XML representation. Where Key -> Value is represented as @{code Value}. Supports nested map structures e.g. <a><b>c</b></a> = a -> b -> c

Parameters:

map - The map to convert

Returns:

An XML string representing the map

surroundWithTag

public static java.lang.String surroundWithTag(java.lang.String tagName,
                                               java.lang.Object value)

Surround a given string with an "XML tag" e.g. <tagName>value</tagName>

Parameters:

tagName - The tag name to surround

value - The value to be surrounded (this will be converted to a string using toString()

Returns:

A string representing the value surrounded by xml tags

surroundWithTag

public static java.lang.String surroundWithTag(java.lang.String tagName,
                                               java.lang.Object value,
                                               java.util.Map<java.lang.String,java.lang.String> attributes)

Surround a given string with an "XML tag" e.g. <tagNam attributeName="attributeValue">value</tagName>

Parameters:

tagName - The tag name to surround

value - The value to be surrounded (this will be converted to a string using toString()

attributes - A map of XML attributes to set on the surrounding tag

Returns:

A string representing the value surrounded by xml tags

surroundWithListTag

public static java.lang.String surroundWithListTag(java.lang.String tagName,
                                                   java.lang.Object value)

Surround a given string with a list tag <tagName type = 'list'>data</tagName>

Parameters:

tagName - The tag name to surround with list tag

value - The value to be surrounded (this will be converted to a string using toString()

Returns:

A string representing the value surrounded by xml tags

topologyTypeToTagName

public static java.lang.String topologyTypeToTagName(java.lang.String topologyType)

Return the XML tag for the Collector.GetConnections(int, String, String) surrounding tag given a specific connection topology type, such as "Layer1"

Parameters:

topologyType - The connection topology type, such as Layer1, Layer2, Microwave

Returns:

The XML tag name for this conneciton data, for example layer1Connections, layer2Connections, microwaveConnections

xmlToMap

public static java.lang.Object xmlToMap(java.lang.String xml)

Convert an XML string to a map representation, in the inverse way to mapToXML(Map). So the string @{code ABC} would be converted to a map of: ( a -> A, b -> ( c -> BC ) )

Parameters:

xml - The xml string to convert

Returns:

A map representing the XML string, or a flat string if not XML

getTransFacInstance

public static javax.xml.transform.TransformerFactory getTransFacInstance()

getDocumentBuilder

public static javax.xml.parsers.DocumentBuilderFactory getDocumentBuilder()

getSaxParserObj

public static javax.xml.parsers.SAXParser getSaxParserObj()
                                                   throws javax.xml.parsers.ParserConfigurationException,
                                                          org.xml.sax.SAXException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

getXmlInputFactory

public static javax.xml.stream.XMLInputFactory getXmlInputFactory()