com.redhat.lightblue.crud

Interface CRUDController

public interface CRUDController

Method Summary

Modifier and Type	Method and Description
CRUDDeleteResponse	delete(CRUDOperationContext ctx, QueryExpression query) Deletes documents matching the search criteria
CRUDFindResponse	find(CRUDOperationContext ctx, QueryExpression query, Projection projection, Sort sort, Long from, Long to) Searches for documents
MetadataListener	getMetadataListener() Return an implementation of MetadataListener interface to receive notifications about metadata operations.
CRUDInsertionResponse	insert(CRUDOperationContext ctx, Projection projection) Performs insertion of documents to the back end
CRUDSaveResponse	save(CRUDOperationContext ctx, boolean upsert, Projection projection) Performs update or insertion of documents to the back end
CRUDUpdateResponse	update(CRUDOperationContext ctx, QueryExpression query, UpdateExpression update, Projection projection) Updates documents matching the search criteria
void	updatePredefinedFields(CRUDOperationContext ctx, JsonDoc doc) The back end should update the predefined fields of the document

Method Detail

insert

CRUDInsertionResponse insert(CRUDOperationContext ctx,
                             Projection projection)

Performs insertion of documents to the back end

Parameters:

ctx - Operation context

projection - If non-null, the inserted documents are projected using this projection and returned in the response The ctx must provide access to the correct versions of metadata used to insert all the documents. All documents must be of the same entity type. If projection is non-null, the data must be projected and returned, otherwise, no data is returned.

save

CRUDSaveResponse save(CRUDOperationContext ctx,
                      boolean upsert,
                      Projection projection)

Performs update or insertion of documents to the back end

Parameters:

ctx - Operation context

upsert - If true, and if a document does not exist, it is inserted

projection - If non-null, the inserted/updated documents are projected using this projection and returned in the response The ctx must provide access to the correct versions of metadata used to insert/update all the documents. All documents must be of the same entity type. If a document has nonnull _id field, the document is updated in the db. Otherwise, if upsert is true, the document is updated. If projection is non-null, the data must be projected and returned, otherwise, no data is returned.

update

CRUDUpdateResponse update(CRUDOperationContext ctx,
                          QueryExpression query,
                          UpdateExpression update,
                          Projection projection)

Updates documents matching the search criteria

Parameters:

ctx - Operation context

query - The query specifying the documents to update

update - The update expression specifying the operations to be performed on matching documents

projection - The fields to be returned from the updated documents If projection is non-null, the updated documents are projected and returned.

delete

CRUDDeleteResponse delete(CRUDOperationContext ctx,
                          QueryExpression query)

Deletes documents matching the search criteria

Parameters:

ctx - Operation context

query - The query specifying the documents to delete

find

CRUDFindResponse find(CRUDOperationContext ctx,
                      QueryExpression query,
                      Projection projection,
                      Sort sort,
                      Long from,
                      Long to)

Searches for documents

Parameters:

ctx - Operation context

entity - The entity to search for

query - The query. Cannot be null

projection - What fields to return. Cannot be null

sort - Sort keys. Can be null

from - starting index in the result set. Can be null. Meaninguful only if a sort is given. Starts from 0.

to - end index in the result set. Starts from 0, and inclusive. Can be null.

getMetadataListener

MetadataListener getMetadataListener()

Return an implementation of MetadataListener interface to receive notifications about metadata operations. Returns null if this implementation is not interested in receiving metadata notifications

updatePredefinedFields

void updatePredefinedFields(CRUDOperationContext ctx,
                            JsonDoc doc)

The back end should update the predefined fields of the document