com.redhat.lightblue.crud

Class DocCtx

java.lang.Object

com.redhat.lightblue.util.JsonDoc

com.redhat.lightblue.crud.DocCtx

All Implemented Interfaces:

Serializable

public class DocCtx
extends JsonDoc

This class represents a document and its related copies, errors, and the operation performed on the document DocCtx provides four views of a document:

• DocCtx instance: This is the document on which we operate.
• originalDoc: This is the copy of the document before any modifications are done on it. This has to be explicitly set.
• outputDoc: This is the version of the document that is projected to be returned. Initially it points to DocCtx instance, and must be explicitly set to point to something else if projections are applied, or null if document will not appear in the output.
• updatedDoc: This is the copy of the unprojected updated document . This has to be explicitly set (expected on the update & save operations).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocCtx(JsonDoc doc)

Method Summary

Methods

Modifier and Type	Method and Description
void	addError(Error e) Adds an error to this document
void	addErrors(Collection<Error> l) Adds errors to this document
void	copyOriginalFromThis() Sets the original document to a copy of this object reference
void	copyUpdatedDocFromOutputDoc() Sets the unprojected output document to a copy of output document
CRUDOperation	getCRUDOperationPerformed() Returns the operation performed on this document
DataError	getDataError() If there are errors for this documents, returns a data error.
List<Error>	getErrors() Returns the errors associated with this document
JsonDoc	getOriginalDocument() Returns the copy of the document before any modifications
JsonDoc	getOutputDocument() Returns the projected output document
Object	getProperty(String name) Properties for the document context
JsonDoc	getUpdatedDocument() Returns the copy of the unprojected output document.
boolean	hasErrors() Returns if the document has any associated errors
void	setCRUDOperationPerformed(CRUDOperation op) Sets the operation performed on this document
void	setOriginalDocument(JsonDoc doc) Sets the copy of the document before any modifications
void	setOutputDocument(JsonDoc doc) Set the projected output document
void	setProperty(String name, Object value) Properties for the document context
void	setUpdatedDocument(JsonDoc doc) Sets a JsonDoc which must contain the unprojected updated document
void	startModifications() This method is to be called before starting making modifications on the document, so that a copy of the original can be saved.

Methods inherited from class com.redhat.lightblue.util.JsonDoc

copy, cursor, cursor, cursor, docList, get, get, getAllNodes, getRoot, listToDoc, modify, modify, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocCtx

public DocCtx(JsonDoc doc)

Method Detail

addError

public void addError(Error e)

Adds an error to this document

addErrors

public void addErrors(Collection<Error> l)

Adds errors to this document

getErrors

public List<Error> getErrors()

Returns the errors associated with this document

hasErrors

public boolean hasErrors()

Returns if the document has any associated errors

getOutputDocument

public JsonDoc getOutputDocument()

Returns the projected output document

setOutputDocument

public void setOutputDocument(JsonDoc doc)

Set the projected output document

getOriginalDocument

public JsonDoc getOriginalDocument()

Returns the copy of the document before any modifications

copyOriginalFromThis

public void copyOriginalFromThis()

Sets the original document to a copy of this object reference

startModifications

public void startModifications()

This method is to be called before starting making modifications on the document, so that a copy of the original can be saved. It'll create a copy of the current status of the document if there isn't one set already. If the output document has already set, it will also make a copy to the updated document field

setOriginalDocument

public void setOriginalDocument(JsonDoc doc)

Sets the copy of the document before any modifications

getCRUDOperationPerformed

public CRUDOperation getCRUDOperationPerformed()

Returns the operation performed on this document

setCRUDOperationPerformed

public void setCRUDOperationPerformed(CRUDOperation op)

Sets the operation performed on this document

getDataError

public DataError getDataError()

If there are errors for this documents, returns a data error. Otherwise, returns null.

getProperty

public Object getProperty(String name)

Properties for the document context

setProperty

public void setProperty(String name,
               Object value)

Properties for the document context

getUpdatedDocument

public JsonDoc getUpdatedDocument()

Returns the copy of the unprojected output document. To access the projected output document, see getOutputDocument() method

copyUpdatedDocFromOutputDoc

public void copyUpdatedDocFromOutputDoc()

Sets the unprojected output document to a copy of output document

setUpdatedDocument

public void setUpdatedDocument(JsonDoc doc)

Sets a JsonDoc which must contain the unprojected updated document