be.adaxisoft.flat

Class Flat

java.lang.Object

be.adaxisoft.flat.Flat

public class Flat
extends Object

This library flattens JSON files.

Before:

{
        "key1": {
                "keyA": "valueI"
        },
        "key2": {
                "keyB": "valueII"
        },
        "key3": { "a": { "b": { "c": 2 } } }
}
 

After:

{
        "key1.keyA": "valueI",
        "key2.keyB": "valueII",
        "key3.a.b.c": 2
}
 

The library can do the reverse operation as well: unflatten.

Author:

Gérik Bonaert

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DELIMITER The default delimiter is used by methods that do not specify a delimiter.

Method Summary

Methods

Modifier and Type	Method and Description
static String	flatten(org.json.JSONObject jsonObject) This method flattens the given JSON object.
static String	flatten(org.json.JSONObject jsonObject, String delimiter) This method flattens the given JSON object.
static String	flatten(String jsonString) This method flattens the string representation of the JSON object.
static String	flatten(String jsonString, String delimiter) This method flattens the string representation of the JSON object.
static org.json.JSONObject	flattenToJSONObject(org.json.JSONObject jsonObject) This method flattens the given JSON object.
static org.json.JSONObject	flattenToJSONObject(org.json.JSONObject jsonObject, String delimiter) This method flattens the string representation of the JSON object.
static org.json.JSONObject	flattenToJSONObject(String jsonString) This method flattens the string representation of the JSON object.
static org.json.JSONObject	flattenToJSONObject(String jsonString, String delimiter) This method flattens the string representation of the JSON object.
static String	unflatten(org.json.JSONObject flatJsonObject) This method takes a flattened JSON object and returns it to the conventional format.
static String	unflatten(org.json.JSONObject flatJsonObject, String delimiter) This method takes a flattened JSON object and returns it to the conventional format.
static String	unflatten(String flatJsonString) This method takes the string representation of a flattened JSON object and returns it to the conventional format.
static String	unflatten(String flatJsonString, String delimiter) This method takes the string representation of a flattened JSON object and returns it to the conventional format.
static org.json.JSONObject	unflattenToJSONObject(org.json.JSONObject flatJsonObject) This method takes a flattened JSON object and returns it to the conventional format.
static org.json.JSONObject	unflattenToJSONObject(org.json.JSONObject flatJsonObject, String delimiter) This method takes a flattened JSON object and returns it to the conventional format.
static org.json.JSONObject	unflattenToJSONObject(String flatJsonObject) This method takes the string representation of a flattened JSON object and returns it to the conventional format.
static org.json.JSONObject	unflattenToJSONObject(String flatJsonString, String delimiter) This method takes the string representation of a flattened JSON object and returns it to the conventional format.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELIMITER

public static final String DEFAULT_DELIMITER

The default delimiter is used by methods that do not specify a delimiter. The default value of the delimiter is '.' (dot).

See Also:

Constant Field Values

Method Detail

flatten

public static String flatten(org.json.JSONObject jsonObject)
                      throws org.json.JSONException

This method flattens the given JSON object. It will use the default delimiter. Your keys cannot contain the default delimiter.

Parameters:

jsonObject - the JSON object to flatten

Returns:

a string representation of the flattened JSON document.

Throws:

org.json.JSONException

flatten

public static String flatten(String jsonString)
                      throws org.json.JSONException

This method flattens the string representation of the JSON object. It will use the default delimiter. Your keys cannot contain the default delimiter.

Parameters:

jsonString - the string representation of the JSON object.

Returns:

a string representation of the flattened JSON document.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

flatten

public static String flatten(org.json.JSONObject jsonObject,
             String delimiter)
                      throws org.json.JSONException

This method flattens the given JSON object. It will use the given delimiter to separate keys and indexes. Your keys cannot contain the given delimiter.
Running the following code:

 Flat.flatten(new JSONObject("\"key1": { \"nested1\" : 1, \"nested2\" : 2 }}"), "@");
 

will generate:

 {
        "key1@nested1" : 1
        "key1@nested2" : 2
 }
 

instead of the default:

 {
        "key1.nested1" : 1
        "key1.nested2" : 2
 }
 

Parameters:

jsonObject - the JSON object to flatten

delimiter - the delimiter to use when joining the keys.

Returns:

a string representation of the flattened JSON document.

Throws:

org.json.JSONException

flatten

public static String flatten(String jsonString,
             String delimiter)
                      throws org.json.JSONException

This method flattens the string representation of the JSON object. It will use the given delimiter to separate keys and indexes. Your keys cannot contain the given delimiter.
Running the following code:

        Flat.flatten("\"key1": { \"nested1\" : 1, \"nested2\" : 2 }}", "@");
 

will generate:

 {
        "key1@nested1" : 1
        "key1@nested2" : 2
 }
 

instead of the default:

 {
        "key1.nested1" : 1
        "key1.nested2" : 2
 }
 

Parameters:

jsonString - the string representation of the JSON object.

delimiter - the delimiter to use when joining the keys.

Returns:

a string representation of the flattened JSON document.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

flattenToJSONObject

public static org.json.JSONObject flattenToJSONObject(String jsonString)
                                               throws org.json.JSONException

This method flattens the string representation of the JSON object. It will use the default delimiter. Your keys cannot contain the default delimiter.

Parameters:

jsonString - the string representation of the JSON object.

Returns:

a flattened JSON object.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

flattenToJSONObject

public static org.json.JSONObject flattenToJSONObject(org.json.JSONObject jsonObject)
                                               throws org.json.JSONException

This method flattens the given JSON object. It will use the default delimiter. Your keys cannot contain the default delimiter.

Parameters:

jsonObject - the JSON object to flatten.

Returns:

a flattened JSON object.

Throws:

org.json.JSONException

flattenToJSONObject

public static org.json.JSONObject flattenToJSONObject(String jsonString,
                                      String delimiter)
                                               throws org.json.JSONException

This method flattens the string representation of the JSON object. It will use the given delimiter to separate keys and indexes. Your keys cannot contain the given delimiter.

Parameters:

jsonString - the string representation of the JSON object.

delimiter - the delimiter to use when joining the keys.

Returns:

a flattened JSON object.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

flattenToJSONObject

public static org.json.JSONObject flattenToJSONObject(org.json.JSONObject jsonObject,
                                      String delimiter)
                                               throws org.json.JSONException

This method flattens the string representation of the JSON object. It will use the given delimiter to separate keys and indexes. Your keys cannot contain the given delimiter.

Parameters:

jsonObject - the JSON object to flatten.

delimiter - the delimiter to use when joining the keys.

Returns:

a flattened JSON object.

Throws:

org.json.JSONException

unflatten

public static String unflatten(String flatJsonString)
                        throws org.json.JSONException

This method takes the string representation of a flattened JSON object and returns it to the conventional format. It will use the default delimiter.

Parameters:

flatJsonString - the string representation of the JSON object.

Returns:

a string representation of a conventional JSON object.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

unflatten

public static String unflatten(org.json.JSONObject flatJsonObject)
                        throws org.json.JSONException

This method takes a flattened JSON object and returns it to the conventional format. It will use the default delimiter.

Parameters:

flatJsonObject - the JSON object to unflatten.

Returns:

a string representation of a conventional JSON object.

Throws:

org.json.JSONException

unflatten

public static String unflatten(String flatJsonString,
               String delimiter)
                        throws org.json.JSONException

This method takes the string representation of a flattened JSON object and returns it to the conventional format. It will use the given delimiter.

Parameters:

flatJsonString - the JSON object to unflatten.

delimiter - the delimiter to use when splitting the keys.

Returns:

a string representation of a conventional JSON object.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

unflatten

public static String unflatten(org.json.JSONObject flatJsonObject,
               String delimiter)
                        throws org.json.JSONException

This method takes a flattened JSON object and returns it to the conventional format. It will use the given delimiter.

Parameters:

flatJsonObject - the JSON object to unflatten.

delimiter - the delimiter to use when splitting the keys.

Returns:

a string representation of a conventional JSON object.

Throws:

org.json.JSONException

unflattenToJSONObject

public static org.json.JSONObject unflattenToJSONObject(String flatJsonObject)
                                                 throws org.json.JSONException

This method takes the string representation of a flattened JSON object and returns it to the conventional format. It will use the default delimiter.

Parameters:

flatJsonObject - the string representation of the JSON object.

Returns:

a conventional JSON object.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

unflattenToJSONObject

public static org.json.JSONObject unflattenToJSONObject(org.json.JSONObject flatJsonObject)
                                                 throws org.json.JSONException

This method takes a flattened JSON object and returns it to the conventional format. It will use the default delimiter.

Parameters:

flatJsonObject - the JSON object to unflatten.

Returns:

a conventional JSON object.

Throws:

org.json.JSONException

unflattenToJSONObject

public static org.json.JSONObject unflattenToJSONObject(String flatJsonString,
                                        String delimiter)
                                                 throws org.json.JSONException

This method takes the string representation of a flattened JSON object and returns it to the conventional format. It will use the given delimiter.

Parameters:

flatJsonString - the JSON object to unflatten.

delimiter - the delimiter to use when splitting the keys.

Returns:

a conventional JSON object.

Throws:

org.json.JSONException - when the given string cannot be parsed to a JSON object.

unflattenToJSONObject

public static org.json.JSONObject unflattenToJSONObject(org.json.JSONObject flatJsonObject,
                                        String delimiter)
                                                 throws org.json.JSONException

This method takes a flattened JSON object and returns it to the conventional format. It will use the given delimiter.

Parameters:

flatJsonObject - the JSON object to unflatten.

delimiter - the delimiter to use when splitting the keys.

Returns:

a conventional JSON object.

Throws:

org.json.JSONException