org.qbroker.json

Class JSON2Map

java.lang.Object

org.qbroker.json.JSON2Map

public class JSON2Map
extends java.lang.Object

JSON2Map parses a JSON text stream and maps the structural content of the JSON into Java objects stored in a Map. It only recognizes three basic Java objects, String, List and Map. A Map or a List can contain any objects of the three types. They are the nodes of the data tree. A String is only a leaf in the data tree. For JSON's numbers, decimals and boolean values, they will be stored as String. For JSON's null, it will stored as null. The comments in Javascript style will be ignored. With these three basic types of objects, any data structures will be representable. The mapping is one-to-one. Therefore, the mapping is bi-directional.

The method of parse() assumes the JSON data is either a Map or a List and returns a Map or a List representing the unescaped JSON data. The method of isArray() can be used to test if the JSON data is a Map or a List.

The method of get() returns the JSON object referenced by the JSONPath. Currently, it only supports simple JSONPath with delimiter of dot. The array index can be a number or a simplate expression within the solid bracket. In case of expressions, the variable of #{xxxx} references the value of the key xxxx with the current map in a list context. It does not support fancy expressions. Please check with dust.js for the JSON path.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	bufferSize
static int	JSON_ARRAY
static int	JSON_BOOLEAN
static int	JSON_MAP
static int	JSON_NULL
static int	JSON_NUMBER
static int	JSON_STRING
static int	JSON_UNKNOWN

Method Summary

Modifier and Type	Method and Description
static boolean	containsKey(java.util.List pl, java.lang.String keyPath) returns true if the keyPath exists or false otherwise
static boolean	containsKey(java.util.Map ph, java.lang.String keyPath) returns true if the keyPath exists or false otherwise
static int	count(java.util.List pl, java.lang.String keyPath) returns the number of children referenced by the keyPath or -1
static int	count(java.util.Map ph, java.lang.String keyPath) returns the number of children referenced by the keyPath or -1
static java.lang.String	diff(java.util.List ps, java.util.List pt, java.lang.String indent) It returns the difference in JSON between two Lists
static java.lang.String	diff(java.util.Map ps, java.util.Map pt, java.lang.String indent) It returns the difference in JSON between two Maps
static int	escape(char[] buffer, int offset, int length) returns the position of the first escaped char or -1 if not found
static int	evaluateIndex(java.lang.String expr, java.util.List list) returns the evaluated index of the list or -1 on failure or no hit
static void	flatten(java.util.Map m) It converts a multi-layered map into a flat map with the leaves only.
static void	flatten(java.lang.String s, java.util.Map m)
static java.lang.String	format(java.util.List pl, Template temp) returns the formatted JSON text for the given template or null
static java.lang.String	format(java.util.Map ph, Template temp) returns the formatted JSON text for the given template or null
static java.lang.Object	get(java.util.List pl, java.lang.String keyPath) returns the raw object referenced by the keyPath or null
static java.lang.Object	get(java.util.Map ph, java.lang.String keyPath) returns the raw object referenced by the keyPath or null
static int	getDataType(java.util.List pl, java.lang.String keyPath)
static int	getDataType(java.util.Map ph, java.lang.String keyPath)
static java.lang.Object	getParent(java.util.List pl, java.lang.String keyPath) returns the parent of the object referenced by the keyPath or null
static java.lang.Object	getParent(java.util.Map ph, java.lang.String keyPath) returns the parent of the object referenced by the keyPath or null
static boolean	isArray(java.lang.String text)
static boolean	isHash(java.lang.String text)
static int	locate(int id, java.lang.String text)
static int	locate(int id, java.lang.String text, int fromIndex) locates the end position of the first JSON object on the id-th level from the starting point of fromIndex and returns the position or -1 upon failure.
static int	look(char[] buffer, int offset, int length) returns the position of the first end chars or -1 if not found
static void	main(java.lang.String[] args)
static int	next(char[] buffer, int offset, int length) returns the position of the first comment char or -1 if not found
static java.lang.String	normalize(java.util.List a) returns JSON content for a given List in alphabetical ascending order
static java.lang.String	normalize(java.util.List a, java.lang.String indent, java.lang.String end) It returns JSON content for a given List in alphabetical ascending order
static java.lang.String	normalize(java.util.Map m) returns JSON content for a given Map in alphabetical ascending order
static java.lang.String	normalize(java.util.Map m, java.lang.String indent, java.lang.String end) It returns JSON content for a given Map in alphabatical ascending order
static java.lang.Object	parse(java.io.Reader in) parses JSON stream from in and returns either a Map or a List with unescaped JSON data.
static java.lang.Object	parseJSON(java.io.Reader in, boolean withOrder) parses JSON stream from in and returns either a Map or a List with unescaped JSON data as well as the key list with orginal order for maps.
static java.lang.Object	put(java.util.List pl, java.lang.String keyPath, java.lang.Object data) puts raw data and returns the replaced object referenced by the keyPath
static java.lang.Object	put(java.util.Map ph, java.lang.String keyPath, java.lang.Object data) puts raw data and returns the replaced object referenced by the keyPath
static java.lang.Object	remove(java.util.List pl, java.lang.String keyPath) returns the removed object referenced by the keyPath or null
static java.lang.Object	remove(java.util.Map ph, java.lang.String keyPath) returns the removed object referenced by the keyPath or null
static int	scan(char[] buffer, int offset, int length, char target) returns the position of the first target or -1 if not found
static int	skip(char[] buffer, int offset, int length) returns the position of the first non-space char or -1 if not found
static java.lang.String	toJSON(java.util.List a, java.lang.String indent, java.lang.String end) It returns JSON content for a given List with indent
protected static java.lang.String	toJSON(java.util.List a, java.lang.String indent, java.lang.String end, boolean withOrder) It returns JSON content for a given List with indent and ordering support
static java.lang.String	toJSON(java.util.Map m) It returns JSON content in the tabular format for a given Map
protected static java.lang.String	toJSON(java.util.Map m, boolean withOrder) It returns JSON content for a given Map with ordering support
static java.lang.String	toJSON(java.util.Map m, java.lang.String indent, java.lang.String end) It returns JSON content for a given Map with indent
protected static java.lang.String	toJSON(java.util.Map m, java.lang.String indent, java.lang.String end, boolean withOrder) It returns JSON content for a given Map with indent and ordering support
static java.lang.String	toXML(java.util.Map m) It returns XML content in the tabular format for a given Map
static java.lang.String	toXML(java.util.Map m, java.lang.String indent, java.lang.String end) It returns XML content for a given Map with indent
static java.lang.String	toXML(java.lang.String key, java.util.List a, java.lang.String indent, java.lang.String end) It returns XML content for a given List with indent
static java.lang.String	trim(java.lang.StringBuffer strBuf) trims off white space chars on both ends and returns the string
static void	unflatten(java.util.Map m) It unflattens a flat map into a multi-layered map.
static void	unflatten(java.lang.String s, java.util.Map m)

Methods inherited from class java.lang.Object

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

Field Detail

bufferSize

public static final int bufferSize

See Also:

Constant Field Values

JSON_UNKNOWN

public static final int JSON_UNKNOWN

See Also:

Constant Field Values

JSON_NULL

public static final int JSON_NULL

See Also:

Constant Field Values

JSON_STRING

public static final int JSON_STRING

See Also:

Constant Field Values

JSON_NUMBER

public static final int JSON_NUMBER

See Also:

Constant Field Values

JSON_BOOLEAN

public static final int JSON_BOOLEAN

See Also:

Constant Field Values

JSON_ARRAY

public static final int JSON_ARRAY

See Also:

Constant Field Values

JSON_MAP

public static final int JSON_MAP

See Also:

Constant Field Values

Method Detail

toJSON

public static java.lang.String toJSON(java.util.Map m)

It returns JSON content in the tabular format for a given Map

toJSON

protected static java.lang.String toJSON(java.util.Map m,
                                         boolean withOrder)

It returns JSON content for a given Map with ordering support

toJSON

public static java.lang.String toJSON(java.util.Map m,
                                      java.lang.String indent,
                                      java.lang.String end)

It returns JSON content for a given Map with indent

toJSON

protected static java.lang.String toJSON(java.util.Map m,
                                         java.lang.String indent,
                                         java.lang.String end,
                                         boolean withOrder)

It returns JSON content for a given Map with indent and ordering support

toJSON

public static java.lang.String toJSON(java.util.List a,
                                      java.lang.String indent,
                                      java.lang.String end)

It returns JSON content for a given List with indent

toJSON

protected static java.lang.String toJSON(java.util.List a,
                                         java.lang.String indent,
                                         java.lang.String end,
                                         boolean withOrder)

It returns JSON content for a given List with indent and ordering support

normalize

public static java.lang.String normalize(java.util.Map m)

returns JSON content for a given Map in alphabetical ascending order

normalize

public static java.lang.String normalize(java.util.Map m,
                                         java.lang.String indent,
                                         java.lang.String end)

It returns JSON content for a given Map in alphabatical ascending order

normalize

public static java.lang.String normalize(java.util.List a)

returns JSON content for a given List in alphabetical ascending order

normalize

public static java.lang.String normalize(java.util.List a,
                                         java.lang.String indent,
                                         java.lang.String end)

It returns JSON content for a given List in alphabetical ascending order

diff

public static java.lang.String diff(java.util.Map ps,
                                    java.util.Map pt,
                                    java.lang.String indent)

It returns the difference in JSON between two Maps

diff

public static java.lang.String diff(java.util.List ps,
                                    java.util.List pt,
                                    java.lang.String indent)

It returns the difference in JSON between two Lists

flatten

public static void flatten(java.util.Map m)

It converts a multi-layered map into a flat map with the leaves only. The flattened keys are the JSON paths to the leaves in the original map.

flatten

public static void flatten(java.lang.String s,
                           java.util.Map m)

unflatten

public static void unflatten(java.util.Map m)

It unflattens a flat map into a multi-layered map.

unflatten

public static void unflatten(java.lang.String s,
                             java.util.Map m)

toXML

public static java.lang.String toXML(java.util.Map m)

It returns XML content in the tabular format for a given Map

toXML

public static java.lang.String toXML(java.util.Map m,
                                     java.lang.String indent,
                                     java.lang.String end)

It returns XML content for a given Map with indent

toXML

public static java.lang.String toXML(java.lang.String key,
                                     java.util.List a,
                                     java.lang.String indent,
                                     java.lang.String end)

It returns XML content for a given List with indent

containsKey

public static boolean containsKey(java.util.Map ph,
                                  java.lang.String keyPath)

returns true if the keyPath exists or false otherwise

containsKey

public static boolean containsKey(java.util.List pl,
                                  java.lang.String keyPath)

returns true if the keyPath exists or false otherwise

count

public static int count(java.util.Map ph,
                        java.lang.String keyPath)

returns the number of children referenced by the keyPath or -1

count

public static int count(java.util.List pl,
                        java.lang.String keyPath)

returns the number of children referenced by the keyPath or -1

remove

public static java.lang.Object remove(java.util.Map ph,
                                      java.lang.String keyPath)

returns the removed object referenced by the keyPath or null

remove

public static java.lang.Object remove(java.util.List pl,
                                      java.lang.String keyPath)

returns the removed object referenced by the keyPath or null

getParent

public static java.lang.Object getParent(java.util.Map ph,
                                         java.lang.String keyPath)

returns the parent of the object referenced by the keyPath or null

getParent

public static java.lang.Object getParent(java.util.List pl,
                                         java.lang.String keyPath)

returns the parent of the object referenced by the keyPath or null

get

public static java.lang.Object get(java.util.Map ph,
                                   java.lang.String keyPath)

returns the raw object referenced by the keyPath or null

get

public static java.lang.Object get(java.util.List pl,
                                   java.lang.String keyPath)

returns the raw object referenced by the keyPath or null

getDataType

public static int getDataType(java.util.Map ph,
                              java.lang.String keyPath)

getDataType

public static int getDataType(java.util.List pl,
                              java.lang.String keyPath)

put

public static java.lang.Object put(java.util.Map ph,
                                   java.lang.String keyPath,
                                   java.lang.Object data)

puts raw data and returns the replaced object referenced by the keyPath

put

public static java.lang.Object put(java.util.List pl,
                                   java.lang.String keyPath,
                                   java.lang.Object data)

puts raw data and returns the replaced object referenced by the keyPath

format

public static java.lang.String format(java.util.Map ph,
                                      Template temp)

returns the formatted JSON text for the given template or null

format

public static java.lang.String format(java.util.List pl,
                                      Template temp)

returns the formatted JSON text for the given template or null

evaluateIndex

public static int evaluateIndex(java.lang.String expr,
                                java.util.List list)

returns the evaluated index of the list or -1 on failure or no hit

parse

public static java.lang.Object parse(java.io.Reader in)
                              throws java.io.IOException

parses JSON stream from in and returns either a Map or a List with unescaped JSON data. It is MT-safe

Throws:

java.io.IOException

parseJSON

public static java.lang.Object parseJSON(java.io.Reader in,
                                         boolean withOrder)
                                  throws java.io.IOException

parses JSON stream from in and returns either a Map or a List with unescaped JSON data as well as the key list with orginal order for maps. The key list is stored at the empty key in the same map. It is MT-safe

Throws:

java.io.IOException

scan

public static int scan(char[] buffer,
                       int offset,
                       int length,
                       char target)

returns the position of the first target or -1 if not found

next

public static int next(char[] buffer,
                       int offset,
                       int length)

returns the position of the first comment char or -1 if not found

escape

public static int escape(char[] buffer,
                         int offset,
                         int length)

returns the position of the first escaped char or -1 if not found

look

public static int look(char[] buffer,
                       int offset,
                       int length)

returns the position of the first end chars or -1 if not found

skip

public static int skip(char[] buffer,
                       int offset,
                       int length)

returns the position of the first non-space char or -1 if not found

trim

public static java.lang.String trim(java.lang.StringBuffer strBuf)

trims off white space chars on both ends and returns the string

isHash

public static boolean isHash(java.lang.String text)

isArray

public static boolean isArray(java.lang.String text)

locate

public static int locate(int id,
                         java.lang.String text)

locate

public static int locate(int id,
                         java.lang.String text,
                         int fromIndex)

locates the end position of the first JSON object on the id-th level from the starting point of fromIndex and returns the position or -1 upon failure. If id = 0, it returns the beginning position of the json data.

main

public static void main(java.lang.String[] args)