com.redhat.lightblue.crud

Class FindRequest

java.lang.Object

com.redhat.lightblue.util.JsonObject

com.redhat.lightblue.Request

com.redhat.lightblue.crud.FindRequest

All Implemented Interfaces:

WithProjection, WithQuery, WithRange, Serializable

public class FindRequest
extends Request
implements WithQuery, WithProjection, WithRange

Request to find documents

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
FindRequest()

Method Summary

Modifier and Type	Method and Description
static FindRequest	fromJson(com.fasterxml.jackson.databind.node.ObjectNode node) Parses a find request from a json object.
CRUDFindRequest	getCRUDFindRequest()
Long	getFrom() Specifies the index in the result set to start returning documents.
CRUDOperation	getOperation()
Projection	getProjection() Specifies what fields of the documents to return
QueryExpression	getQuery() The query
Sort	getSort() Specifies the order in which the documents will be returned
Long	getTo() Specifies the last index of the document in the result set to be returned.
void	setFrom(Long l) Specifies the index in the result set to start returning documents.
void	setProjection(Projection x) Specifies what fields of the documents to return
void	setQuery(QueryExpression q) The query
void	setSort(Sort s) Specifies the order in which the documents will be returned
void	setTo(Long l) Specifies the last index of the document in the result set to be returned.
void	shallowCopyFrom(FindRequest r)
void	shallowCopyFrom(Request r, CRUDFindRequest c)
com.fasterxml.jackson.databind.JsonNode	toJson() Returns 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

FindRequest

public FindRequest()

Method Detail

getQuery

public QueryExpression getQuery()

The query

Specified by:

getQuery in interface WithQuery

setQuery

public void setQuery(QueryExpression q)

The query

getProjection

public Projection getProjection()

Specifies what fields of the documents to return

Specified by:

getProjection in interface WithProjection

setProjection

public void setProjection(Projection x)

Specifies what fields of the documents to return

getSort

public Sort getSort()

Specifies the order in which the documents will be returned

setSort

public void setSort(Sort s)

Specifies the order in which the documents will be returned

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 l)

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

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 l)

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

getCRUDFindRequest

public CRUDFindRequest getCRUDFindRequest()

shallowCopyFrom

public void shallowCopyFrom(FindRequest r)

shallowCopyFrom

public void shallowCopyFrom(Request r,
                            CRUDFindRequest c)

getOperation

public CRUDOperation getOperation()

Specified by:

getOperation in class Request

toJson

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

Returns JSON representation of this

Overrides:

toJson in class Request

fromJson

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

Parses a find request from a json object. Unrecognized elements are ignored.

Specified by:

fromJson in interface WithRange