ca.carleton.gcrc.couch.utils

Class SubmissionUtils

java.lang.Object

ca.carleton.gcrc.couch.utils.SubmissionUtils

public class SubmissionUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubmissionUtils.DocAndReserved

Constructor Summary

Constructors

Constructor and Description
SubmissionUtils()

Method Summary

Modifier and Type	Method and Description
static SubmissionUtils.DocAndReserved	computeDocAndReservedFromDocument(org.json.JSONObject doc) Given a JSON document, breaks the document into two parts: the doc and reserved portions.
static org.json.JSONObject	getApprovedDocumentFromSubmission(org.json.JSONObject submissionDoc) Re-creates the approved document submitted by the client from the submission document.
static String	getDocumentIdentifierFromSubmission(org.json.JSONObject submissionDoc) Computes the target document identifier for this submission.
static org.json.JSONObject	getOriginalDocumentFromSubmission(org.json.JSONObject submissionDoc) Re-creates the original document when the submission was proposed from the submission document.
static org.json.JSONObject	getSubmittedDocumentFromSubmission(org.json.JSONObject submissionDoc) Re-creates the document submitted by the client from the submission document.
static org.json.JSONObject	recreateDocumentFromDocAndReserved(org.json.JSONObject doc, org.json.JSONObject reserved) Re-creates a document given the document and the reserved keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionUtils

public SubmissionUtils()

Method Detail

getDocumentIdentifierFromSubmission

public static String getDocumentIdentifierFromSubmission(org.json.JSONObject submissionDoc)
                                                  throws Exception

Computes the target document identifier for this submission. Returns null if it can not be found.

Parameters:

submissionDoc - Submission document from the submission database

Returns:

Document identifier for the submitted document

Throws:

Exception

getSubmittedDocumentFromSubmission

public static org.json.JSONObject getSubmittedDocumentFromSubmission(org.json.JSONObject submissionDoc)
                                                              throws Exception

Re-creates the document submitted by the client from the submission document.

Parameters:

submissionDoc - Submission document from the submission database

Returns:

Document submitted by user for update

Throws:

Exception

getOriginalDocumentFromSubmission

public static org.json.JSONObject getOriginalDocumentFromSubmission(org.json.JSONObject submissionDoc)
                                                             throws Exception

Re-creates the original document when the submission was proposed from the submission document.

Parameters:

submissionDoc - Submission document from the submission database

Returns:

Original document when submission was provided

Throws:

Exception

getApprovedDocumentFromSubmission

public static org.json.JSONObject getApprovedDocumentFromSubmission(org.json.JSONObject submissionDoc)
                                                             throws Exception

Re-creates the approved document submitted by the client from the submission document.

Parameters:

submissionDoc - Submission document from the submission database

Returns:

Document submitted by user for update

Throws:

Exception

recreateDocumentFromDocAndReserved

public static org.json.JSONObject recreateDocumentFromDocAndReserved(org.json.JSONObject doc,
                                                                     org.json.JSONObject reserved)
                                                              throws Exception

Re-creates a document given the document and the reserved keys.

Parameters:

doc - Main document

reserved - Document that contains reserved keys. A reserve key starts with an underscore. In this document, the reserved keys do not have the starting underscore.

Returns:

Throws:

Exception

computeDocAndReservedFromDocument

public static SubmissionUtils.DocAndReserved computeDocAndReservedFromDocument(org.json.JSONObject doc)
                                                                        throws Exception

Given a JSON document, breaks the document into two parts: the doc and reserved portions.

Parameters:

doc -

Returns:

Throws:

Exception