com.redhat.lightblue.crud

Class UpdateRequest

java.lang.Object

com.redhat.lightblue.util.JsonObject

com.redhat.lightblue.Request

com.redhat.lightblue.crud.UpdateRequest

All Implemented Interfaces:

WithProjection, WithQuery, WithRange, Serializable

public class UpdateRequest
extends Request
implements WithQuery, WithProjection, WithRange

Request to update documents based on a query

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.redhat.lightblue.crud.WithRange

WithRange.Range

Constructor Summary

Constructors

Constructor and Description
UpdateRequest()

Method Summary

Modifier and Type	Method and Description
static UpdateRequest	fromJson(com.fasterxml.jackson.databind.node.ObjectNode node) Parses an update request from a Json object
Long	getFrom() Specifies the index in the result set to start returning documents.
CRUDOperation	getOperation()
Projection	getProjection()
QueryExpression	getQuery() The query specifying which documents to be updated
Projection	getReturnFields() The fields to return from the updated documents
Long	getTo() Specifies the last index of the document in the result set to be returned.
UpdateExpression	getUpdateExpression() The expression specifying how to modify the documents
void	setFrom(Long from)
void	setQuery(QueryExpression q) The query specifying which documents to be updated
void	setReturnFields(Projection p) The fields to return from the updated documents
void	setTo(Long to)
void	setUpdateExpression(UpdateExpression x) The expression specifying how to modify the documents
com.fasterxml.jackson.databind.JsonNode	toJson() Returns a json representation of this

Methods inherited from class com.redhat.lightblue.Request

getClientId, getEntityVersion, getExecution, parse, setClientId, setEntityVersion, setExecution, shallowCopyFrom

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

getFactory, getSourceNode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.redhat.lightblue.crud.WithRange

toJson

Constructor Detail

UpdateRequest

public UpdateRequest()

Method Detail

getReturnFields

public Projection getReturnFields()

The fields to return from the updated documents

setReturnFields

public void setReturnFields(Projection p)

The fields to return from the updated documents

getProjection

public Projection getProjection()

Specified by:

getProjection in interface WithProjection

getUpdateExpression

public UpdateExpression getUpdateExpression()

The expression specifying how to modify the documents

setUpdateExpression

public void setUpdateExpression(UpdateExpression x)

The expression specifying how to modify the documents

getQuery

public QueryExpression getQuery()

The query specifying which documents to be updated

Specified by:

getQuery in interface WithQuery

setQuery

public void setQuery(QueryExpression q)

The query specifying which documents to be updated

getFrom

public Long getFrom()

Description copied from interface: WithRange

Specifies the index in the result set to start returning documents. Meaningful only if sort is given. Starts from 0.

Specified by:

getFrom in interface WithRange

setFrom

public void setFrom(Long from)

getTo

public Long getTo()

Description copied from interface: WithRange

Specifies the last index of the document in the result set to be returned. Meaningful only if sort is given. Starts from 0.

Specified by:

getTo in interface WithRange

setTo

public void setTo(Long to)

getOperation

public CRUDOperation getOperation()

Specified by:

getOperation in class Request

toJson

public com.fasterxml.jackson.databind.JsonNode toJson()

Returns a json representation of this

Overrides:

toJson in class Request

fromJson

public static UpdateRequest fromJson(com.fasterxml.jackson.databind.node.ObjectNode node)

Parses an update request from a Json object

Specified by:

fromJson in interface WithRange