com.whitestein.lsps.json.function

Interface JsonFunctions

All Known Implementing Classes:

JsonFunctionsBean

public interface JsonFunctions

Set of functions for conversion between lsps objects and JSON (both directions).

Author:

jsa

Method Summary

Modifier and Type	Method and Description
String	convertToJson(ExecutionContext context, Boolean useExternalRef, Object object) Creates a JSON document representing a given LSPS object.
String	convertToJson(ExecutionContext context, Object object) Creates a JSON document representing a given LSPS object.
MapHolder	jsonToMap(ExecutionContext context, String jsonString) TODO
MapHolder	jsonToMap(ExecutionContext context, String json, Boolean doInsert, Boolean doUpdate)
String	mapToJson(ExecutionContext context, Boolean useExternalRef, MapHolder map) Creates a JSON document representing the given map.
String	mapToJson(ExecutionContext context, MapHolder map) Creates a JSON document representing the given map.
Object	parseJson(ExecutionContext context, String json, Type resultType) Parses the given JSON document into the instance of the given type
Object	parseJson(ExecutionContext context, String json, Type resultType, Boolean doInsert, Boolean doUpdate) Parses JSON string to internal data structures.
String	toJsonSchema(ExecutionContext context, Boolean useExternalRef, Type type)

Method Detail

toJsonSchema

String toJsonSchema(ExecutionContext context,
                    Boolean useExternalRef,
                    Type type)
             throws ErrorException

Throws:

ErrorException

convertToJson

String convertToJson(ExecutionContext context,
                     Boolean useExternalRef,
                     Object object)
              throws ErrorException

Creates a JSON document representing a given LSPS object. If the useExternalRef is true the shared records are represented by an external reference (type and primary key) in the json. In the other case the full value is put into json string.

Parameters:

context -

useExternalRef -

object -

Returns:

a JSON document representing the given object

Throws:

ErrorException

convertToJson

String convertToJson(ExecutionContext context,
                     Object object)
              throws ErrorException

Creates a JSON document representing a given LSPS object. The shared records are represented by full value in the json.

Parameters:

context -

object - The object to convert to JSON representation. The parameter must be of RecordType or ContainerType or MapType.

Returns:

a JSON document representing the given object

Throws:

ErrorException

parseJson

Object parseJson(ExecutionContext context,
                 String json,
                 Type resultType)
          throws ErrorException

Parses the given JSON document into the instance of the given type

Parameters:

context -

json - the JSON string

resultType -

Returns:

parsed object

Throws:

ErrorException

parseJson

Object parseJson(ExecutionContext context,
                 String json,
                 Type resultType,
                 Boolean doInsert,
                 Boolean doUpdate)
          throws ErrorException

Parses JSON string to internal data structures. The json parameter represents the JSON string to parse and the resultType parameter determines the type of the returned data. The referred type must be a Record, List, Set or Map type, otherwise an exception is thrown. Furthermore the data structure represented by the resultType can consist only from these supported types: String, Boolean, Binary, Decimal, Integer, Date, Set, List, Map, Record, Enumeration. If there exist a shared record with the same primary key as specified in JSON the record is used by import. Here, it does not matter whether the shared record is specified by external reference or by value in JSON. If the record specified by reference in JSON does not exist in database it is ignored and null is used as its imported value or empty collection for collection of records. No exception is thrown in this case. If the parameter doInsert is true and the database does not contain a shared record specified by value in JSON or the JSON does not specify primary key, the record from JSON is inserted to database. For auto-generated primary keys, a new key value is created, for not auto-generated primary keys, the value of the key from JSON is used. If doInsert is false, a record from JSON which does not exist in the DB is ignored and null is used for its value in the imported data instead; for collections of non-existing records, empty collections are created by import. If the parameter doUpdate is true and the database contains a shared record with the same primary key as a record specified by value in JSON, values of this record fields are updated from JSON. If false, values of fields do not change.

Parameters:

context -

json -

resultType -

doInsert -

doUpdate -

Returns:

parsed object

Throws:

ErrorException

mapToJson

String mapToJson(ExecutionContext context,
                 Boolean useExternalRef,
                 MapHolder map)
          throws ErrorException

Creates a JSON document representing the given map. This method is useful for creating JSON representation of data structures for which there is no record representation in the model. These data structures can always be represented as a map where keys are the property names and values are their values. If the useExternalRef is true the shared records are represented by an external reference (type and primary key) in the json. In the other case the full value is put into json string.

Parameters:

context -

useExternalRef -

map - The map to convert to JSON. The type of the map has to be Map<String, Object>.

Returns:

a JSON representation of the map.

Throws:

ErrorException

mapToJson

String mapToJson(ExecutionContext context,
                 MapHolder map)
          throws ErrorException

Creates a JSON document representing the given map. This method is useful for creating JSON representation of data structures for which there is no record representation in the model. These data structures can always be represented as a map where keys are the property names and values are their values.

Parameters:

context -

map - The map to convert to JSON. The type of the map has to be Map<String, Object>.

Returns:

a JSON representation of the map.

Throws:

ErrorException

jsonToMap

MapHolder jsonToMap(ExecutionContext context,
                    String jsonString)
             throws ErrorException

TODO

Parameters:

context -

jsonString -

Returns:

parsed map

Throws:

ErrorException

jsonToMap

MapHolder jsonToMap(ExecutionContext context,
                    String json,
                    Boolean doInsert,
                    Boolean doUpdate)
             throws ErrorException

Parameters:

context -

json -

doInsert -

doUpdate -

Returns:

parsed map

Throws:

ErrorException