net.sf.practicalxml.converter

Class CollectionConverter

java.lang.Object

net.sf.practicalxml.converter.CollectionConverter

public class CollectionConverter
extends Object

Converts between an XML DOM and hierarchical Java collections, according to the following rules:

From DOM to Collection:

• The top-level Element is transformed into Map.
• The keys of this map will be the local names of the child elements, sans prefix.
• Children that have text content will map to String values.
• Children that have element content will map to Map values, and processed recursively.
• Mixed content is not permitted; if an element contains mixed content, the text nodes will be discarded.
• If multiple child elements have the same name, they will map to a List, which in turn contains either strings or maps.
• Empty elements are added to the map with a value of null.
• Order of keys is not preserved, but order of repeated elements is.

From Collection to DOM:

• A Map is converted to an element with children, where each key in the map becomes an Element.
• String values are turned into text nodes under the key element.
• Map values are turned into elements recursively.
• List and Set values are turned into repeated elements with the same key (and may be in turn either strings or maps).

Each of the conversion functions allows the caller to specify a list of keys as a filter. If these keys are present, only the specified keys will be processed from the input.

Since:

1.1.3

Constructor Summary

Constructors

Constructor and Description
CollectionConverter()

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,?>	convertToMap(Element elem, Set<String> keyFilter) Common conversion code for a single element, with digested filter.
static Map<String,?>	convertToMap(Element elem, String... keyFilter) Converts a single XML element into a map.
static List<Map<String,?>>	convertToMap(List<Element> elems, String... keyFilter) Converts a list of XML elements into a list of maps.
static Document	convertToXml(Map<String,?> map, QName rootName, String... keyFilter) Creates a new DOM document from the passed map, in which all elements are members of the specified namespace and will inherit the root's prefix (if any).
static Document	convertToXml(Map<String,?> map, String rootName, String... keyFilter) Creates a new DOM document from the passed map, without any namespace.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionConverter

public CollectionConverter()

Method Detail

convertToXml

public static Document convertToXml(Map<String,?> map,
                    String rootName,
                    String... keyFilter)

Creates a new DOM document from the passed map, without any namespace.

Parameters:

map - The source object. Its elements will be the children of the document root.

rootName - The local name given to the root element of the generated document.

keyFilter - If present, the mappings will be limited to child elements with the specified names.

convertToXml

public static Document convertToXml(Map<String,?> map,
                    QName rootName,
                    String... keyFilter)

Creates a new DOM document from the passed map, in which all elements are members of the specified namespace and will inherit the root's prefix (if any).

Parameters:

map - The source object. Its elements will be the children of the document root.

rootName - The qualified name given to the root element of the generated document (this is a QName to avoid ambiguous argument lists).

keyFilter - If present, the mappings will be limited to child elements with the specified names.

convertToMap

public static Map<String,?> convertToMap(Element elem,
                         String... keyFilter)

Converts a single XML element into a map.

Parameters:

elem - The element.

keyFilter - If present, the mappings will be limited to child elements with the specified names.

convertToMap

public static List<Map<String,?>> convertToMap(List<Element> elems,
                               String... keyFilter)

Converts a list of XML elements into a list of maps.

Parameters:

elems - The elements.

keyFilter - If present, the mappings will be limited to child elements with the specified names.

convertToMap

public static Map<String,?> convertToMap(Element elem,
                         Set<String> keyFilter)

Common conversion code for a single element, with digested filter.

Parameters:

elem - The element.

keyFilter - If not null contains the child element names that will be put in the map.