com.viaoa.json

Class OAJson

java.lang.Object

com.viaoa.json.OAJson

Direct Known Subclasses:

OAXml

public class OAJson
extends Object

JSON serialization for OA. Works dynamically with OAObject Graphs to allow property paths to be included.

This is also able to work with POJO classes that dont always have pkey properties, but instead use importMatch properties or linkMany unique. OAJson will find (or create) the correct OAObject that does have the matching value(s).
ex: Customer.id, and Customer.custNumber, where OAObject Customer has an Id (pkey) and custNumber (int prop, but not key). The Pojo class does not have to have the Id.
also, a link could be an importMatch (ex: custNumber can be flagged as an importMatch).

Internally uses (/depends on) Jackson's ObjectMapper.

Note: this is not thread safe.

Author:

vvia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAJson.StackItem

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object	lock
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Constructor and Description
OAJson()

Method Summary

Modifier and Type	Method and Description
protected static String	_convertMethodArgumentsToJson(OAJson oaj, Method method, Object[] argValues, List<String>[] lstIncludePropertyPathss, int[] skipParams)
void	addPropertyPath(String propertyPath) Add property paths to include when writing.
void	addPropertyPaths(List<String> pps)
void	afterReadCallback(com.fasterxml.jackson.databind.JsonNode node, Object objNew)
protected void	afterReadJson()
void	beforeReadCallback(com.fasterxml.jackson.databind.JsonNode node)
void	clearPropertyPaths()
static OAObjectKey	convertJsonSinglePartIdToObjectKey(Class<? extends OAObject> clazz, String strSinglePartId)
static Object[]	convertJsonToMethodArguments(com.fasterxml.jackson.databind.node.ArrayNode nodeArray, Method method, int[] skipParams)
protected static Object[]	convertJsonToMethodArguments(OAJson oaj, com.fasterxml.jackson.databind.node.ArrayNode nodeArray, Method method, int[] skipParams)
static Object[]	convertJsonToMethodArguments(String jsonArray, Method method) Convert a json array to the argument values of a method.
static String	convertMethodArgumentsToJson(Method method, Object[] argValues, List<String>[] lstIncludePropertyPathss, int[] skipParams) Used to serialize the arguments into a Json array.
static OAObjectKey	convertNumberToObjectKey(Class<? extends OAObject> clazz, int id)
static String	convertObjectKeyToJsonSinglePartId(OAObjectKey oaObjKey)
String	convertToPretty(String json)
static com.fasterxml.jackson.databind.ObjectMapper	createJsonObjectMapper()
String	format(String json)
OACascade	getCascade()
String	getCurrentPropertyPath() PropertyPath that is currently being read/written.
Map<Integer,OAObject>	getGuidMap()
List<OAObjectImportMatchDelegate.ImportMatch>	getImportMatchList()
boolean	getIncludeAll()
boolean	getIncludeOwned()
static com.fasterxml.jackson.databind.ObjectMapper	getJsonObjectMapper()
com.fasterxml.jackson.databind.JsonNode	getNode(com.fasterxml.jackson.databind.JsonNode parentNode, String propertyPath)
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
String	getPropertyNameCallback(Object obj, String defaultName)
ArrayList<String>	getPropertyPaths()
Object	getPropertyValueCallback(Object obj, String propertyName, Object defaultValue)
boolean	getReadingPojo()
Class<? extends OAObject>	getReadObjectClass() Used internally to know the class of the root node.
OAObject	getRoot() Root object used from call to readIntoObject.
OAJson.StackItem	getStackItem()
com.fasterxml.jackson.databind.ObjectMapper	getUnsharedObjectMapper()
boolean	getUsePropertyCallback(Object obj, String propertyName)
boolean	getWriteAsPojo()
boolean	isReadingPojo()
<T extends OAObject> void	readIntoHub(File file, Hub<T> hub, boolean bIsLoading)
<T extends OAObject> void	readIntoHub(com.fasterxml.jackson.databind.ObjectMapper om, com.fasterxml.jackson.databind.JsonNode nodeRoot, Hub<T> hub, boolean bIsLoading)
<T extends OAObject> void	readIntoHub(String json, Hub<T> hub, boolean bIsLoading)
void	readIntoObject(InputStream is, OAObject root)
void	readIntoObject(InputStream is, OAObject root, boolean bIsLoading)
void	readIntoObject(String json, OAObject root) Read JSON into an existing root Object.
void	readIntoObject(String json, OAObject root, boolean bIsLoading)
<T> List<T>	readList(File file, Class<T> clazz, boolean bIsLoading)
<T> List<T>	readList(InputStream stream, Class<T> clazz, boolean bIsLoading)
<T> List<T>	readList(String json, Class<T> clazz, boolean bIsLoading)
<K,V> Map<K,V>	readMap(String json, Class<K> clazzKey, Class<V> clazzValue, boolean bIsLoading)
<T> T	readObject(File file, Class<T> clazz, boolean bIsLoading) Convert a JSON file to an OAObject graph.
<T> T	readObject(InputStream stream, Class<T> clazz, boolean bIsLoading) Read JSON from stream into Object.
<T> T	readObject(String json, Class<T> clazz) Read Object from JSON.
<T> T	readObject(String json, Class<T> clazz, boolean bIsLoading) Convert a JSON string to an Object graph.
com.fasterxml.jackson.databind.JsonNode	readTree(InputStream is)
com.fasterxml.jackson.databind.JsonNode	readTree(String json)
protected void	reset()
void	setCaseInsensitive()
void	setIncludeAll(boolean b) Flag to know if ALL references are included, default is false. Note that references will be used, so that duplicates are not created and circular references are avoided.
void	setIncludeOwned(boolean b) Flag to know if owned references are included, default is true.
void	setReadingPojo(boolean b) Flag to know if the JSON that is being read is from a POJO.
void	setStackItem(OAJson.StackItem si)
void	setWriteAsPojo(boolean b) This will include additional properties that could be used in Pojo, but are not needed in the OAObject. For example, pojos that do not have pkey properties and rely other data for uniqueness.
String	toJson(Object obj)
String	write(Hub<? extends OAObject> hub)
void	write(Hub<? extends OAObject> hub, File file)
String	write(Object obj) Convert OAObject to a JSON string, including any owned Links, and links in propertyPaths.
void	write(Object obj, File file) Convert OAObject to a JSON string, including any owned Links, and links in propertyPaths.
void	write(Object obj, OutputStream stream) Convert OAObject to a JSON stream.

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected static final Object lock

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Detail

OAJson

public OAJson()

Method Detail

getImportMatchList

public List<OAObjectImportMatchDelegate.ImportMatch> getImportMatchList()

setReadingPojo

public void setReadingPojo(boolean b)

Flag to know if the JSON that is being read is from a POJO.

isReadingPojo

public boolean isReadingPojo()

getReadingPojo

public boolean getReadingPojo()

setIncludeOwned

public void setIncludeOwned(boolean b)

Flag to know if owned references are included, default is true.

getIncludeOwned

public boolean getIncludeOwned()

setIncludeAll

public void setIncludeAll(boolean b)

Flag to know if ALL references are included, default is false.
Note that references will be used, so that duplicates are not created and circular references are avoided.

getIncludeAll

public boolean getIncludeAll()

reset

protected void reset()

getReadObjectClass

public Class<? extends OAObject> getReadObjectClass()

Used internally to know the class of the root node.

addPropertyPath

public void addPropertyPath(String propertyPath)

Add property paths to include when writing.

addPropertyPaths

public void addPropertyPaths(List<String> pps)

getPropertyPaths

public ArrayList<String> getPropertyPaths()

clearPropertyPaths

public void clearPropertyPaths()

getJsonObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper getJsonObjectMapper()

createJsonObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper createJsonObjectMapper()

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getUnsharedObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getUnsharedObjectMapper()

setCaseInsensitive

public void setCaseInsensitive()

toJson

public String toJson(Object obj)
              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

write

public String write(Object obj)
             throws com.fasterxml.jackson.core.JsonProcessingException

Convert OAObject to a JSON string, including any owned Links, and links in propertyPaths.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

convertToPretty

public String convertToPretty(String json)
                       throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

format

public String format(String json)
              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

write

public void write(Object obj,
                  File file)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  IOException

Convert OAObject to a JSON string, including any owned Links, and links in propertyPaths.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

write

public void write(Object obj,
                  OutputStream stream)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  IOException

Convert OAObject to a JSON stream.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readObject

public <T> T readObject(String json,
                        Class<T> clazz)
                 throws com.fasterxml.jackson.core.JsonProcessingException

Read Object from JSON. If OAObject, then first search and find matching objects to read into.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getStackItem

public OAJson.StackItem getStackItem()

setStackItem

public void setStackItem(OAJson.StackItem si)

getRoot

public OAObject getRoot()

Root object used from call to readIntoObject.

readIntoObject

public void readIntoObject(String json,
                           OAObject root)
                    throws com.fasterxml.jackson.core.JsonProcessingException

Read JSON into an existing root Object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

readIntoObject

public void readIntoObject(String json,
                           OAObject root,
                           boolean bIsLoading)
                    throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

readIntoObject

public void readIntoObject(InputStream is,
                           OAObject root)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readIntoObject

public void readIntoObject(InputStream is,
                           OAObject root,
                           boolean bIsLoading)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readObject

public <T> T readObject(String json,
                        Class<T> clazz,
                        boolean bIsLoading)
                 throws com.fasterxml.jackson.core.JsonProcessingException

Convert a JSON string to an Object graph. If OAObject, then first search and find matching objects to read into.

Parameters:

bIsLoading - (default = false), if true then threadLocal.setLoading(true) will be used before loading.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

afterReadJson

protected void afterReadJson()

readObject

public <T> T readObject(InputStream stream,
                        Class<T> clazz,
                        boolean bIsLoading)
                 throws com.fasterxml.jackson.core.JsonProcessingException,
                        IOException

Read JSON from stream into Object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readObject

public <T> T readObject(File file,
                        Class<T> clazz,
                        boolean bIsLoading)
                 throws com.fasterxml.jackson.core.JsonProcessingException,
                        IOException

Convert a JSON file to an OAObject graph.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readMap

public <K,V> Map<K,V> readMap(String json,
                              Class<K> clazzKey,
                              Class<V> clazzValue,
                              boolean bIsLoading)
                       throws com.fasterxml.jackson.core.JsonProcessingException,
                              IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readList

public <T> List<T> readList(String json,
                            Class<T> clazz,
                            boolean bIsLoading)
                     throws com.fasterxml.jackson.core.JsonProcessingException,
                            IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readList

public <T> List<T> readList(File file,
                            Class<T> clazz,
                            boolean bIsLoading)
                     throws com.fasterxml.jackson.core.JsonProcessingException,
                            IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

readList

public <T> List<T> readList(InputStream stream,
                            Class<T> clazz,
                            boolean bIsLoading)
                     throws com.fasterxml.jackson.core.JsonProcessingException,
                            IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

getCascade

public OACascade getCascade()

getGuidMap

public Map<Integer,OAObject> getGuidMap()

write

public void write(Hub<? extends OAObject> hub,
                  File file)
           throws com.fasterxml.jackson.core.JsonProcessingException,
                  IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

write

public String write(Hub<? extends OAObject> hub)
             throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

readIntoHub

public <T extends OAObject> void readIntoHub(File file,
                                             Hub<T> hub,
                                             boolean bIsLoading)
                                      throws Exception

Throws:

Exception

readIntoHub

public <T extends OAObject> void readIntoHub(String json,
                                             Hub<T> hub,
                                             boolean bIsLoading)
                                      throws Exception

Throws:

Exception

readIntoHub

public <T extends OAObject> void readIntoHub(com.fasterxml.jackson.databind.ObjectMapper om,
                                             com.fasterxml.jackson.databind.JsonNode nodeRoot,
                                             Hub<T> hub,
                                             boolean bIsLoading)
                                      throws Exception

Throws:

Exception

convertJsonSinglePartIdToObjectKey

public static OAObjectKey convertJsonSinglePartIdToObjectKey(Class<? extends OAObject> clazz,
                                                             String strSinglePartId)

convertNumberToObjectKey

public static OAObjectKey convertNumberToObjectKey(Class<? extends OAObject> clazz,
                                                   int id)

convertObjectKeyToJsonSinglePartId

public static String convertObjectKeyToJsonSinglePartId(OAObjectKey oaObjKey)

convertMethodArgumentsToJson

public static String convertMethodArgumentsToJson(Method method,
                                                  Object[] argValues,
                                                  List<String>[] lstIncludePropertyPathss,
                                                  int[] skipParams)
                                           throws Exception

Used to serialize the arguments into a Json array. This will also include json properties for setting(/casting) if the object is different then the parameter type.

Throws:

Exception

_convertMethodArgumentsToJson

protected static String _convertMethodArgumentsToJson(OAJson oaj,
                                                      Method method,
                                                      Object[] argValues,
                                                      List<String>[] lstIncludePropertyPathss,
                                                      int[] skipParams)
                                               throws Exception

Throws:

Exception

convertJsonToMethodArguments

public static Object[] convertJsonToMethodArguments(String jsonArray,
                                                    Method method)
                                             throws Exception

Convert a json array to the argument values of a method.

Throws:

Exception

convertJsonToMethodArguments

public static Object[] convertJsonToMethodArguments(com.fasterxml.jackson.databind.node.ArrayNode nodeArray,
                                                    Method method,
                                                    int[] skipParams)
                                             throws Exception

Throws:

Exception

convertJsonToMethodArguments

protected static Object[] convertJsonToMethodArguments(OAJson oaj,
                                                       com.fasterxml.jackson.databind.node.ArrayNode nodeArray,
                                                       Method method,
                                                       int[] skipParams)
                                                throws Exception

Throws:

Exception

readTree

public com.fasterxml.jackson.databind.JsonNode readTree(String json)
                                                 throws Exception

Throws:

Exception

readTree

public com.fasterxml.jackson.databind.JsonNode readTree(InputStream is)
                                                 throws Exception

Throws:

Exception

getNode

public com.fasterxml.jackson.databind.JsonNode getNode(com.fasterxml.jackson.databind.JsonNode parentNode,
                                                       String propertyPath)

getCurrentPropertyPath

public String getCurrentPropertyPath()

PropertyPath that is currently being read/written.

getPropertyNameCallback

public String getPropertyNameCallback(Object obj,
                                      String defaultName)

getPropertyValueCallback

public Object getPropertyValueCallback(Object obj,
                                       String propertyName,
                                       Object defaultValue)

getUsePropertyCallback

public boolean getUsePropertyCallback(Object obj,
                                      String propertyName)

beforeReadCallback

public void beforeReadCallback(com.fasterxml.jackson.databind.JsonNode node)

afterReadCallback

public void afterReadCallback(com.fasterxml.jackson.databind.JsonNode node,
                              Object objNew)

setWriteAsPojo

public void setWriteAsPojo(boolean b)

This will include additional properties that could be used in Pojo, but are not needed in the OAObject.
For example, pojos that do not have pkey properties and rely other data for uniqueness. (importMatch, link with unique prop, key from reference)

getWriteAsPojo

public boolean getWriteAsPojo()