com.redhat.lightblue.crud

Class CRUDFindRequest

java.lang.Object

com.redhat.lightblue.crud.CRUDFindRequest

All Implemented Interfaces:

WithRange, Serializable

public class CRUDFindRequest
extends Object
implements Serializable, 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
CRUDFindRequest()

Method Summary

Modifier and Type	Method and Description
void	fromJson(com.fasterxml.jackson.databind.node.ObjectNode node) Parses a find request from a json object.
Long	getFrom() Specifies the index in the result set to start returning documents.
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(CRUDFindRequest r) Shallow copy from r to this
void	toJson(com.fasterxml.jackson.databind.node.JsonNodeFactory factory, com.fasterxml.jackson.databind.node.ObjectNode node) Populates an object node with the JSON representation of this

Methods inherited from class java.lang.Object

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

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

fromJson, toJson

Constructor Detail

CRUDFindRequest

public CRUDFindRequest()

Method Detail

getQuery

public QueryExpression getQuery()

The query

setQuery

public void setQuery(QueryExpression q)

The query

getProjection

public Projection getProjection()

Specifies what fields of the documents to return

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

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

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.

shallowCopyFrom

public void shallowCopyFrom(CRUDFindRequest r)

Shallow copy from r to this

toJson

public void toJson(com.fasterxml.jackson.databind.node.JsonNodeFactory factory,
                   com.fasterxml.jackson.databind.node.ObjectNode node)

Populates an object node with the JSON representation of this

fromJson

public void fromJson(com.fasterxml.jackson.databind.node.ObjectNode node)

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