com.googlecode.mjorm.query

Class DaoQuery

java.lang.Object

com.googlecode.mjorm.query.criteria.AbstractCriterion

com.googlecode.mjorm.query.criteria.AbstractCriterionBuilder<T>

com.googlecode.mjorm.query.criteria.AbstractQueryCriterion<DaoQuery>

com.googlecode.mjorm.query.DaoQuery

All Implemented Interfaces:

Criterion

public class DaoQuery
extends AbstractQueryCriterion<DaoQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DaoQuery.CursorVisitor Allows for the visiting of the DBCursor before it is returned as an ObjectIterator form the various query methods of this class.

Field Summary

Fields inherited from class com.googlecode.mjorm.query.criteria.AbstractCriterionBuilder

criteria, propertyStack

Constructor Summary

Constructors

Constructor and Description
DaoQuery() Creates the DaoQuery.

Method Summary

Methods

Modifier and Type	Method and Description
DaoQuery	addSort(java.lang.String name, java.lang.Integer direction) Adds a sort.
DaoQuery	addSpecial(java.lang.String name, java.lang.Object special) Adds a special.
void	assertValid() Asserts that the DaoQuery is valid.
void	clear() Clears the query.
long	countObjects() Executes the query and returns the number of objects that it would return.
java.util.List<java.lang.Object>	distinct(java.lang.String field) Returns distinct values for the given field.
<T> java.util.List<T>	distinct(java.lang.String field, java.lang.Class<T> expected) Returns distinct values for the given field.
com.mongodb.DBObject	explain() Explains the current query.
com.mongodb.DBObject	findObject() Executes the query and returns objects of the given type.
<T> T	findObject(java.lang.Class<T> clazz) Executes the query and returns an object of the given type.
com.mongodb.DBObject	findObject(com.mongodb.DBObject fields) Executes the query and returns objects of the given type.
com.mongodb.DBCursor	findObjects() Executes the query and returns objects of the given type.
<T> ObjectIterator<T>	findObjects(java.lang.Class<T> clazz) Executes the query and returns objects of the given type.
com.mongodb.DBCursor	findObjects(com.mongodb.DBObject fields) Executes the query and returns objects of the given type.
com.mongodb.DBCursor	findObjects(java.lang.String... fields) Executes the query and returns objects of the given type.
java.lang.String	getCollection() Returns the collection that this query is for.
com.mongodb.DB	getDB() Returns the MongoDao that created this query.
ObjectMapper	getObjectMapper() Returns the ObjectMapper.
com.mongodb.DBObject	getSortDBObject() Creates and returns the DBObject representing the sort for this query.
DaoModifier	modify() Creates a DaoModifier for the current query.
protected DaoQuery	self()
DaoQuery	setBatchSize(java.lang.Integer batchSize)
DaoQuery	setCollection(java.lang.String collection)
DaoQuery	setComment(java.lang.String comment)
DaoQuery	setCursorVisitor(DaoQuery.CursorVisitor cursorVisitor)
DaoQuery	setDB(com.mongodb.DB db)
DaoQuery	setFirstDocument(java.lang.Integer firstDocument)
DaoQuery	setHint(com.mongodb.DBObject hint)
DaoQuery	setHint(java.lang.String hint, int dir)
DaoQuery	setMaxDocuments(java.lang.Integer maxDocuments)
DaoQuery	setObjectMapper(ObjectMapper objectMapper)
DaoQuery	setReadPreference(com.mongodb.ReadPreference readPreference)
DaoQuery	setSnapShot()
DaoQuery	setSnapShot(java.lang.Boolean snapShot)
DaoQuery	setSort(com.mongodb.DBObject sort)
DaoQuery	setSort(java.util.Map<java.lang.String,java.lang.Integer> sort)
void	setSpecials(java.util.Map<java.lang.String,java.lang.Object> specials)

Methods inherited from class com.googlecode.mjorm.query.criteria.AbstractQueryCriterion

all, all, and, and, and, between, elemMatch, eq, exists, gt, gte, in, in, lt, lte, mod, ne, near, near, nin, nin, nor, nor, nor, not, not, or, or, or, regex, regex, regex, size, type, type, within, within, within

Methods inherited from class com.googlecode.mjorm.query.criteria.AbstractCriterionBuilder

add, add, pop, push, toQueryObject

Methods inherited from class java.lang.Object

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

Constructor Detail

DaoQuery

public DaoQuery()

Creates the DaoQuery.

Method Detail

clear

public void clear()

Clears the query.

Overrides:

clear in class AbstractCriterionBuilder<DaoQuery>

assertValid

public void assertValid()

Asserts that the DaoQuery is valid. Throws an exception if not.

modify

public DaoModifier modify()

Creates a DaoModifier for the current query.

Returns:

the DaoModifier

findObjects

public <T> ObjectIterator<T> findObjects(java.lang.Class<T> clazz)

Executes the query and returns objects of the given type.

Parameters:

clazz - the type of objects to return

Returns:

the iterator.

findObjects

public com.mongodb.DBCursor findObjects(com.mongodb.DBObject fields)

Executes the query and returns objects of the given type.

Parameters:

fields - the fields to return

Returns:

the iterator.

findObjects

public com.mongodb.DBCursor findObjects()

Executes the query and returns objects of the given type.

Parameters:

clazz - the type of objects to return

Returns:

the iterator.

findObjects

public com.mongodb.DBCursor findObjects(java.lang.String... fields)

Executes the query and returns objects of the given type.

Parameters:

fields - the type of objects to return

Returns:

the iterator.

findObject

public <T> T findObject(java.lang.Class<T> clazz)

Executes the query and returns an object of the given type.

Parameters:

clazz - the type of object to return

Returns:

the object.

findObject

public com.mongodb.DBObject findObject(com.mongodb.DBObject fields)

Executes the query and returns objects of the given type.

Parameters:

clazz - the type of objects to return

Returns:

the iterator.

findObject

public com.mongodb.DBObject findObject()

Executes the query and returns objects of the given type.

Parameters:

clazz - the type of objects to return

Returns:

the iterator.

countObjects

public long countObjects()

Executes the query and returns the number of objects that it would return.

Returns:

the count

distinct

public java.util.List<java.lang.Object> distinct(java.lang.String field)

Returns distinct values for the given field. This field passed must be the name of a field on a MongoDB document.

Parameters:

field - the field

Returns:

the distinct objects

distinct

public <T> java.util.List<T> distinct(java.lang.String field,
                             java.lang.Class<T> expected)

Returns distinct values for the given field. This field passed must be the name of a field on a MongoDB document.

Parameters:

field - the field

expected - the expected type

Returns:

the distinct objects

explain

public com.mongodb.DBObject explain()

Explains the current query.

Returns:

the explained query

getSortDBObject

public com.mongodb.DBObject getSortDBObject()

Creates and returns the DBObject representing the sort for this query.

Returns:

the sort

self

protected DaoQuery self()

Specified by:

self in class AbstractCriterionBuilder<DaoQuery>

addSort

public DaoQuery addSort(java.lang.String name,
               java.lang.Integer direction)

Adds a sort.

Parameters:

name - the field

direction - the direction

Returns:

self

addSpecial

public DaoQuery addSpecial(java.lang.String name,
                  java.lang.Object special)

Adds a special.

Parameters:

name - the name

special - the special

Returns:

self

setSort

public DaoQuery setSort(java.util.Map<java.lang.String,java.lang.Integer> sort)

Parameters:

sort - the sort to set

setSort

public DaoQuery setSort(com.mongodb.DBObject sort)

Parameters:

sort - the sort to set

setSpecials

public void setSpecials(java.util.Map<java.lang.String,java.lang.Object> specials)

Parameters:

specials - the specials to set

setFirstDocument

public DaoQuery setFirstDocument(java.lang.Integer firstDocument)

Parameters:

firstDocument - the firstDocument to set

setMaxDocuments

public DaoQuery setMaxDocuments(java.lang.Integer maxDocuments)

Parameters:

maxDocuments - the maxDocuments to set

setBatchSize

public DaoQuery setBatchSize(java.lang.Integer batchSize)

Parameters:

batchSize - the batchSize to set

setHint

public DaoQuery setHint(java.lang.String hint,
               int dir)

Parameters:

hint - the hint to set

setHint

public DaoQuery setHint(com.mongodb.DBObject hint)

Parameters:

hint - the hint to set

setSnapShot

public DaoQuery setSnapShot(java.lang.Boolean snapShot)

Parameters:

snapShot - the snapShot to set

setSnapShot

public DaoQuery setSnapShot()

Parameters:

snapShot - the snapShot to set

setComment

public DaoQuery setComment(java.lang.String comment)

Parameters:

comment - the comment to set

setCollection

public DaoQuery setCollection(java.lang.String collection)

Parameters:

collection - the collection to set

setDB

public DaoQuery setDB(com.mongodb.DB db)

Parameters:

mongoDao - the mongoDao to set

setCursorVisitor

public DaoQuery setCursorVisitor(DaoQuery.CursorVisitor cursorVisitor)

Parameters:

cursorVisitor - the cursorVisitor to set

setObjectMapper

public DaoQuery setObjectMapper(ObjectMapper objectMapper)

Parameters:

objectMapper - the objectMapper to set

setReadPreference

public DaoQuery setReadPreference(com.mongodb.ReadPreference readPreference)

Parameters:

readPreference - the readPreference to set

getCollection

public java.lang.String getCollection()

Returns the collection that this query is for.

Returns:

the collection

getDB

public com.mongodb.DB getDB()

Returns the MongoDao that created this query.

Returns:

the mongo dao

getObjectMapper

public ObjectMapper getObjectMapper()

Returns the ObjectMapper.

Returns:

the mongo dao