com.soa.json.xml

Class JSON2XmlSerializer

java.lang.Object

com.soa.json.xml.JSON2XmlSerializer

public class JSON2XmlSerializer
extends java.lang.Object

Converts JSON content to XML.

Constructor Summary

Constructors

Constructor and Description
JSON2XmlSerializer()

Method Summary

Modifier and Type	Method and Description
void	addNamespaceDecl(java.lang.String prefix, java.lang.String namespace) Adds a namespace declaration to the root XML element.
void	addNamespaceDecl(java.lang.String prefix, java.lang.String namespace, java.lang.String xmlElement) Adds a namespace declaration to the given generated XML element.
void	changeObjectName(java.lang.String oldName, java.lang.String newName) Changes the name that a JSON object will have when converted to XML.
java.lang.String	serialize(java.lang.Object json) Converts the given JSON object to an XML string.
java.lang.String	serialize(java.lang.Object json, java.lang.String charset) Converts the given JSON object to an XML string using the given charset.
void	setArrayName(java.lang.String name) Establishes a default XML element name for all un-named JSON arrays.
void	setElementName(java.lang.String name) Establishes a default XML element name for all un-named JSON array elements.
void	setElementName(java.lang.String name, java.lang.String xmlElement) Establishes a default XML element name for all un-named JSON array elements starting from the given XML element in the XML hierarchy.
void	setExpandableArrays(java.lang.String[] arrayNames) Identifies a list of array properties by their names that will be expanded.
void	setExpandNamedArrays(boolean expand) Indicates whether to automatically expand from child to parent all named array elements.
void	setObjectName(java.lang.String name) Establishes a default XML element name for all un-named JSON objects.
void	setRootName(java.lang.String name) Sets the output root XML element's name.
void	setRootName(java.lang.String name, java.lang.String namespace, java.lang.String prefix) Sets the output root XML element's name.
void	setUseParentPrefix(boolean useParentPrefix) Indicates whether prefixes from parent XML elements should automatically be applied to children elements or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSON2XmlSerializer

public JSON2XmlSerializer()

Method Detail

serialize

public java.lang.String serialize(java.lang.Object json,
                                  java.lang.String charset)

Converts the given JSON object to an XML string using the given charset. The object can be a String in JSON format, Java array, Collection, or Map.

Parameters:

json - String in JSON format, Java array, Collection, or Map.

charset - charset to use.

Returns:

String in XML format.

serialize

public java.lang.String serialize(java.lang.Object json)

Converts the given JSON object to an XML string. The default charset will be used. The object can be a String in JSON format, Java array, Collection, or Map.

Parameters:

json - String in JSON format, Java array, Collection, or Map.

Returns:

String in XML format.

setRootName

public void setRootName(java.lang.String name)

Sets the output root XML element's name. The element will have no namespace.

Parameters:

name - Name for the resulting XML root element.

setRootName

public void setRootName(java.lang.String name,
                        java.lang.String namespace,
                        java.lang.String prefix)

Sets the output root XML element's name. The element will have the given namespace and prefix (if supplied).

Parameters:

name - Local part of the root XML element name.

namespace - Namespace of the root XML element name.

prefix - Prefix for the namespace of the root XML element. Optional, can be null.

setExpandNamedArrays

public void setExpandNamedArrays(boolean expand)

Indicates whether to automatically expand from child to parent all named array elements. For example, by setting to true the JSON structure of { "a" : { "b" : [ "1", "2" ] } } will result in XML of <a><b>1</b><b>2</b></a> and a setting of false will result in XML of <a><b><e>1</e><e>2</e></b></a> where 'e' is controlled by setElementName(java.lang.String). The array must be named ("a" in this case) so the name can be used for the element names.

Parameters:

expand - true to expand from child to parent, false to nest the children. The default is false.

setArrayName

public void setArrayName(java.lang.String name)

Establishes a default XML element name for all un-named JSON arrays. If setRootName() has not been called and the root JSON object is an array this name will become the root XML element name. The default name is 'a'.

Parameters:

name - Name for JSON arrays. If a prefix is required it must be part of the name with a : delimiter.

setElementName

public void setElementName(java.lang.String name)

Establishes a default XML element name for all un-named JSON array elements. The default name is 'e'.

Parameters:

name - Name for JSON array elements. If a prefix is required it must be part of the name with a : delimiter.

setElementName

public void setElementName(java.lang.String name,
                           java.lang.String xmlElement)

Establishes a default XML element name for all un-named JSON array elements starting from the given XML element in the XML hierarchy. Typically this will be the XML element name for the array itself. Note it will be the default name for any sub-arrays unless changed.

Parameters:

name - Name for JSON array elements. If a prefix is required it must be part of the name with a : delimiter.

xmlElement - Name of the XML element at which point the given name will become the default. If a prefix is required it must be part of the name with a : delimiter.

setObjectName

public void setObjectName(java.lang.String name)

Establishes a default XML element name for all un-named JSON objects. If setRootName() has not been called and the root JSON object is an object this name will become the root XML element name. The default name is 'o'.

Parameters:

name - Name for JSON objects. If a prefix is required it must be part of the name with a : delimiter.

changeObjectName

public void changeObjectName(java.lang.String oldName,
                             java.lang.String newName)

Changes the name that a JSON object will have when converted to XML. By default an XML element's name will be identical to the original JSON's object. If the JSON object did not have a namespace prefix for example, the XML element would not after conversion. This method could be used to apply that namespace for example or change the name to something else entirely.

Parameters:

oldName - Original JSON name.

newName - New XML name.

setUseParentPrefix

public void setUseParentPrefix(boolean useParentPrefix)

Indicates whether prefixes from parent XML elements should automatically be applied to children elements or not. By default namespace prefixes are not added. The input JSON names must have the prefixes in them already. If the input JSON names do not have namespace prefixes and the goal is to have them in the resulting XML then either changeObjectName() must be called for each JSON name without a prefix or use this setting or both. By setting this to true when an XML element is created, if the parent XML element has a prefix it will automatically be added to the new element.

Parameters:

useParentPrefix - True if namespace prefixes should automatically match the parent XML elements created or false to leave namespace prefixes to match the incoming JSON names.

addNamespaceDecl

public void addNamespaceDecl(java.lang.String prefix,
                             java.lang.String namespace)

Adds a namespace declaration to the root XML element.

Parameters:

prefix - Prefix of the namespace being declared.

namespace - URI of the namespace being declared.

addNamespaceDecl

public void addNamespaceDecl(java.lang.String prefix,
                             java.lang.String namespace,
                             java.lang.String xmlElement)

Adds a namespace declaration to the given generated XML element.

Parameters:

prefix - Prefix of the namespace being declared.

namespace - URI of the namespace being declared.

xmlElement - Generated XML element that will have the declaration. Note: if the generated XML element has a prefix it must be part of this parameter.

setExpandableArrays

public void setExpandableArrays(java.lang.String[] arrayNames)

Identifies a list of array properties by their names that will be expanded. When an array is expanded the array elements are converted to XML as a sequence of repetitive XML elements with their local names equal to the JSON array name. For example, by including the array name of "b" the JSON structure of { "a" : { "b" : [ "1", "2" ] } } will result in XML of <a><b>1</b><b>2</b></a> and not including the array name will result in XML of <a><b><e>1</e><e>2</e></b></a> where 'e' is controlled by setElementName(java.lang.String). The array must be named ("a" in this case) so the name can be used for the element names.

Parameters:

arrayNames - List of array names to expand from child to parent.