com.cybozu.kintone.database

Class JsonParser

java.lang.Object

com.cybozu.kintone.database.JsonParser

public class JsonParser
extends java.lang.Object

JsonParser class converts JSON string to Java object and also Java object to JSON string. Although this class uses Google Gson library, developers don't have to care about that. See the detail of Google Gson. https://code.google.com/p/google-gson/

Constructor Summary

Constructors

Constructor and Description
JsonParser()

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateForAddComment(long app, long record, java.lang.String text, java.util.List<MentionDto> mentions) Generates the json string to add comment.
java.lang.String	generateForDeleteComment(long app, long record, long id) Generates the json string to delete comment.
java.lang.String	generateForUpdateAssignees(long app, long id, java.util.List<java.lang.String> codes, long revision) Generates the json string to update assignees.
java.lang.String	generateForUpdateStatus(long app, java.util.List<java.lang.Long> ids, java.util.List<java.lang.String> actions, java.util.List<java.lang.String> assignees, java.util.List<java.lang.Long> revisions) Generates the json string to update status(for bulk updating).
java.lang.String	generateForUpdateStatus(long app, long id, java.lang.String action, java.lang.String assignee, long revision) Generates the json string to update status.
AppDto	jsonToApp(java.lang.String json) Convert json string to AppDto.
java.util.List<AppDto>	jsonToApps(java.lang.String json) Convert json string to AppDto array.
CommentSet	jsonToCommentSet(Connection con, java.lang.String json) Converts the json string to the commentset object.
ErrorResponse	jsonToErrorResponse(java.lang.String json) Converts the json string to the error response object.
java.lang.String	jsonToFileKey(java.lang.String json) Retrieves the file key string from json string.
long	jsonToId(java.lang.String json) Retrieves the id string from json string.
java.util.List<java.lang.Long>	jsonToIDs(java.lang.String json) Retrieves the array of the ids from json string.
java.util.List<java.lang.Long>	jsonToLongArray(java.lang.String json) Retrieves the array of the Long values from json.
ResultSet	jsonToResultSet(Connection con, java.lang.String json) Converts the json string to the resultset object.
long	jsonToRevision(java.lang.String json) Retrieves the revision string from json string.
java.lang.String	recordsToJsonForDelete(long app, java.util.List<Record> records) Generates the json string for delete method.
java.lang.String	recordsToJsonForInsert(long app, java.util.List<Record> records) Generates the json string for insert method.
java.lang.String	recordsToJsonForUpdate(long app, java.util.List<java.lang.Long> ids, Record record) Generates the json string for update method.
java.lang.String	recordsToJsonForUpdate(long app, java.util.List<Record> records) Generates the json string for update method.
java.lang.String	recordsToJsonForUpdate(long app, Record record) Generates the json string for update method.
java.lang.String	recordsToJsonForUpdateByKey(long app, java.lang.String key, java.util.List<Record> records) Generates the json string for update method.
java.lang.String	recordsToJsonForUpdateByKey(long app, java.lang.String key, Record record) Generates the json string for update method.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonParser

public JsonParser()

Method Detail

jsonToErrorResponse

public ErrorResponse jsonToErrorResponse(java.lang.String json)

Converts the json string to the error response object.

Parameters:

json - a json string

Returns:

error response object

jsonToResultSet

public ResultSet jsonToResultSet(Connection con,
                                 java.lang.String json)
                          throws java.io.IOException

Converts the json string to the resultset object.

Parameters:

con - a connection object

json - a json string

Returns:

resultset object

Throws:

java.io.IOException

recordsToJsonForInsert

public java.lang.String recordsToJsonForInsert(long app,
                                               java.util.List<Record> records)
                                        throws java.io.IOException

Generates the json string for insert method.

Parameters:

app - the application id

records - the array of the record object

Returns:

the json string

Throws:

java.io.IOException

jsonToLongArray

public java.util.List<java.lang.Long> jsonToLongArray(java.lang.String json)

Retrieves the array of the Long values from json.

Parameters:

json - a json string

Returns:

the array of the long value

jsonToIDs

public java.util.List<java.lang.Long> jsonToIDs(java.lang.String json)
                                         throws java.io.IOException

Retrieves the array of the ids from json string.

Parameters:

json - a json string

Returns:

the array of the id

Throws:

java.io.IOException

recordsToJsonForUpdate

public java.lang.String recordsToJsonForUpdate(long app,
                                               java.util.List<java.lang.Long> ids,
                                               Record record)
                                        throws java.io.IOException

Generates the json string for update method.

Parameters:

app - the application id

ids - the array of the record id to be updated

record - the values of updated records

Returns:

json string

Throws:

java.io.IOException

recordsToJsonForUpdate

public java.lang.String recordsToJsonForUpdate(long app,
                                               Record record)
                                        throws java.io.IOException

Generates the json string for update method.

Parameters:

app - application id

record - updated record

Returns:

json string

Throws:

java.io.IOException

recordsToJsonForUpdate

public java.lang.String recordsToJsonForUpdate(long app,
                                               java.util.List<Record> records)
                                        throws java.io.IOException

Generates the json string for update method.

Parameters:

app - the application id

records - an array of the updated records

Returns:

json string

Throws:

java.io.IOException

recordsToJsonForUpdateByKey

public java.lang.String recordsToJsonForUpdateByKey(long app,
                                                    java.lang.String key,
                                                    Record record)
                                             throws java.io.IOException

Generates the json string for update method.

Parameters:

app - application id

key - key field name

record - updated record

Returns:

json string

Throws:

java.io.IOException

recordsToJsonForUpdateByKey

public java.lang.String recordsToJsonForUpdateByKey(long app,
                                                    java.lang.String key,
                                                    java.util.List<Record> records)
                                             throws java.io.IOException

Generates the json string for update method.

Parameters:

app - application id

key - key field name

records - an array of the updated records

Returns:

json string

Throws:

java.io.IOException

recordsToJsonForDelete

public java.lang.String recordsToJsonForDelete(long app,
                                               java.util.List<Record> records)
                                        throws java.io.IOException

Generates the json string for delete method.

Parameters:

app - the application id

records - an array of the records to be deleted

Returns:

json string

Throws:

java.io.IOException

jsonToFileKey

public java.lang.String jsonToFileKey(java.lang.String json)
                               throws java.io.IOException

Retrieves the file key string from json string.

Parameters:

json - a json string

Returns:

the file key

Throws:

java.io.IOException

jsonToRevision

public long jsonToRevision(java.lang.String json)
                    throws java.io.IOException

Retrieves the revision string from json string.

Parameters:

json - a json string

Returns:

the revision number

Throws:

java.io.IOException

jsonToId

public long jsonToId(java.lang.String json)
              throws java.io.IOException

Retrieves the id string from json string.

Parameters:

json - a json string

Returns:

the id number

Throws:

java.io.IOException

jsonToApp

public AppDto jsonToApp(java.lang.String json)
                 throws java.io.IOException

Convert json string to AppDto.

Parameters:

json - a json string

Returns:

app object

Throws:

java.io.IOException

jsonToApps

public java.util.List<AppDto> jsonToApps(java.lang.String json)
                                  throws java.io.IOException

Convert json string to AppDto array.

Parameters:

json - a json string

Returns:

the list of app object

Throws:

java.io.IOException

generateForUpdateAssignees

public java.lang.String generateForUpdateAssignees(long app,
                                                   long id,
                                                   java.util.List<java.lang.String> codes,
                                                   long revision)
                                            throws java.io.IOException

Generates the json string to update assignees.

Parameters:

id - record id

code - array of the code of the assigned users

revision - revision number (-1 means "not set")

Returns:

json string

Throws:

java.io.IOException

generateForUpdateStatus

public java.lang.String generateForUpdateStatus(long app,
                                                long id,
                                                java.lang.String action,
                                                java.lang.String assignee,
                                                long revision)
                                         throws java.io.IOException

Generates the json string to update status.

Parameters:

app - application id

id - record id

action - action name

assignee - login name of the assignee

revision - revision number (-1 means "not set")

Returns:

json string

Throws:

java.io.IOException

generateForUpdateStatus

public java.lang.String generateForUpdateStatus(long app,
                                                java.util.List<java.lang.Long> ids,
                                                java.util.List<java.lang.String> actions,
                                                java.util.List<java.lang.String> assignees,
                                                java.util.List<java.lang.Long> revisions)
                                         throws java.io.IOException

Generates the json string to update status(for bulk updating).

Parameters:

app - application id

ids - an array of the record id

actions - an array of the action name

assignees - an array of the login name of the assignee

revision - an array of the revision number (-1 means "not set")

Returns:

json string

Throws:

java.io.IOException

generateForAddComment

public java.lang.String generateForAddComment(long app,
                                              long record,
                                              java.lang.String text,
                                              java.util.List<MentionDto> mentions)
                                       throws java.io.IOException

Generates the json string to add comment.

Parameters:

app - application id

record - record id

mentions - an array of mentions

Returns:

json string

Throws:

java.io.IOException

generateForDeleteComment

public java.lang.String generateForDeleteComment(long app,
                                                 long record,
                                                 long id)
                                          throws java.io.IOException

Generates the json string to delete comment.

Parameters:

app - application id

record - record id

id - comment id

Returns:

json string

Throws:

java.io.IOException

jsonToCommentSet

public CommentSet jsonToCommentSet(Connection con,
                                   java.lang.String json)
                            throws java.io.IOException

Converts the json string to the commentset object.

Parameters:

json - a json string

Returns:

commentset object

Throws:

java.io.IOException