com.mysema.query.mongodb

Class MongodbQuery<K>

java.lang.Object

com.mysema.query.mongodb.MongodbQuery<K>

Type Parameters:

K -

All Implemented Interfaces:

FilteredClause<MongodbQuery<K>>, SimpleProjectable<K>, SimpleQuery<MongodbQuery<K>>

Direct Known Subclasses:

MorphiaQuery

public abstract class MongodbQuery<K>
extends Object
implements SimpleQuery<MongodbQuery<K>>, SimpleProjectable<K>

MongodbQuery provides a general Querydsl query implementation with a pluggable DBObject to Bean transformation

Author:

laimw

Constructor Summary

Constructors

Constructor and Description
MongodbQuery(com.mongodb.DBCollection collection, com.google.common.base.Function<com.mongodb.DBObject,K> transformer, MongodbSerializer serializer) Create a new MongodbQuery instance

Method Summary

Methods

Modifier and Type	Method and Description
<T> AnyEmbeddedBuilder<K>	anyEmbedded(Path<? extends Collection<T>> collection, Path<T> target) Define a constraint for an embedded object
long	count() Get the count of matched elements
protected com.mongodb.DBCursor	createCursor()
protected com.mongodb.DBCursor	createCursor(com.mongodb.DBCollection collection, Predicate where, List<Expression<?>> projection, QueryModifiers modifiers, List<OrderSpecifier<?>> orderBy)
protected Predicate	createFilter(QueryMetadata metadata)
protected Predicate	createJoinFilter(QueryMetadata metadata)
MongodbQuery<K>	distinct() Set the Query to return distinct results
boolean	exists()
protected abstract com.mongodb.DBCollection	getCollection(Class<?> type)
protected List<Object>	getIds(Class<?> targetType, Predicate condition)
com.mysema.commons.lang.CloseableIterator<K>	iterate() Get the projection as a typed closeable Iterator
com.mysema.commons.lang.CloseableIterator<K>	iterate(Path<?>... paths)
<T> JoinBuilder<K,T>	join(CollectionPathBase<?,T,?> ref, Path<T> target) Define a join
<T> JoinBuilder<K,T>	join(Path<T> ref, Path<T> target) Define a join
MongodbQuery<K>	limit(long limit) Set the limit / max results for the query results
List<K>	list() Get the projection as a typed List
List<K>	list(Path<?>... paths)
SearchResults<K>	listResults() Get the projection in SearchResults form
SearchResults<K>	listResults(Path<?>... paths)
boolean	notExists()
MongodbQuery<K>	offset(long offset) Set the offset for the query results
MongodbQuery<K>	orderBy(OrderSpecifier<?>... o) Add order expressions
MongodbQuery<K>	orderBy(OrderSpecifier<?> o)
MongodbQuery<K>	restrict(QueryModifiers modifiers) Set both limit and offset of the query results
<T> MongodbQuery<K>	set(ParamExpression<T> param, T value) Set the given parameter to the given value
void	setReadPreference(com.mongodb.ReadPreference readPreference)
K	singleResult() Get the projection as a single result or null if no result is found
K	singleResult(Path<?>... paths)
String	toString()
K	uniqueResult() Get the projection as a unique result or null if no result is found
K	uniqueResult(Path<?>... paths)
MongodbQuery<K>	where(Predicate... e) Adds the given filter conditions
MongodbQuery<K>	where(Predicate e)

Methods inherited from class java.lang.Object

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

Constructor Detail

MongodbQuery

public MongodbQuery(com.mongodb.DBCollection collection,
            com.google.common.base.Function<com.mongodb.DBObject,K> transformer,
            MongodbSerializer serializer)

Create a new MongodbQuery instance

Parameters:

collection -

transformer -

serializer -

Method Detail

join

public <T> JoinBuilder<K,T> join(Path<T> ref,
                        Path<T> target)

Define a join

Parameters:

ref -

target -

Returns:

join

public <T> JoinBuilder<K,T> join(CollectionPathBase<?,T,?> ref,
                        Path<T> target)

Define a join

Parameters:

ref -

target -

Returns:

anyEmbedded

public <T> AnyEmbeddedBuilder<K> anyEmbedded(Path<? extends Collection<T>> collection,
                                    Path<T> target)

Define a constraint for an embedded object

Parameters:

collection -

target -

Returns:

getCollection

protected abstract com.mongodb.DBCollection getCollection(Class<?> type)

exists

public boolean exists()

Specified by:

exists in interface SimpleProjectable<K>

Returns:

true, if rows matching the given criteria exist, otherwise false

createFilter

@Nullable
protected Predicate createFilter(QueryMetadata metadata)

createJoinFilter

@Nullable
protected Predicate createJoinFilter(QueryMetadata metadata)

getIds

protected List<Object> getIds(Class<?> targetType,
                  Predicate condition)

notExists

public boolean notExists()

Specified by:

notExists in interface SimpleProjectable<K>

Returns:

true, if no rows matching the given criteria exist, otherwise false

distinct

public MongodbQuery<K> distinct()

Description copied from interface: SimpleQuery

Set the Query to return distinct results

Specified by:

distinct in interface SimpleQuery<MongodbQuery<K>>

Returns:

where

public MongodbQuery<K> where(Predicate e)

where

public MongodbQuery<K> where(Predicate... e)

Description copied from interface: FilteredClause

Adds the given filter conditions

Skips null arguments

Specified by:

where in interface FilteredClause<MongodbQuery<K>>

Parameters:

e - filter conditions to be added

Returns:

limit

public MongodbQuery<K> limit(long limit)

Description copied from interface: SimpleQuery

Set the limit / max results for the query results

Specified by:

limit in interface SimpleQuery<MongodbQuery<K>>

Returns:

offset

public MongodbQuery<K> offset(long offset)

Description copied from interface: SimpleQuery

Set the offset for the query results

Specified by:

offset in interface SimpleQuery<MongodbQuery<K>>

Returns:

restrict

public MongodbQuery<K> restrict(QueryModifiers modifiers)

Description copied from interface: SimpleQuery

Set both limit and offset of the query results

Specified by:

restrict in interface SimpleQuery<MongodbQuery<K>>

Returns:

orderBy

public MongodbQuery<K> orderBy(OrderSpecifier<?> o)

orderBy

public MongodbQuery<K> orderBy(OrderSpecifier<?>... o)

Description copied from interface: SimpleQuery

Add order expressions

Specified by:

orderBy in interface SimpleQuery<MongodbQuery<K>>

Returns:

set

public <T> MongodbQuery<K> set(ParamExpression<T> param,
                      T value)

Description copied from interface: SimpleQuery

Set the given parameter to the given value

Specified by:

set in interface SimpleQuery<MongodbQuery<K>>

Returns:

iterate

public com.mysema.commons.lang.CloseableIterator<K> iterate(Path<?>... paths)

iterate

public com.mysema.commons.lang.CloseableIterator<K> iterate()

Description copied from interface: SimpleProjectable

Get the projection as a typed closeable Iterator

Specified by:

iterate in interface SimpleProjectable<K>

Returns:

list

public List<K> list(Path<?>... paths)

list

public List<K> list()

Description copied from interface: SimpleProjectable

Get the projection as a typed List

Specified by:

list in interface SimpleProjectable<K>

Returns:

createCursor

protected com.mongodb.DBCursor createCursor()

createCursor

protected com.mongodb.DBCursor createCursor(com.mongodb.DBCollection collection,
                                @Nullable
                                Predicate where,
                                List<Expression<?>> projection,
                                QueryModifiers modifiers,
                                List<OrderSpecifier<?>> orderBy)

singleResult

public K singleResult(Path<?>... paths)

singleResult

public K singleResult()

Description copied from interface: SimpleProjectable

Get the projection as a single result or null if no result is found

for multiple results only the first one is returned

Specified by:

singleResult in interface SimpleProjectable<K>

Returns:

uniqueResult

public K uniqueResult(Path<?>... paths)

uniqueResult

public K uniqueResult()

Description copied from interface: SimpleProjectable

Get the projection as a unique result or null if no result is found

Specified by:

uniqueResult in interface SimpleProjectable<K>

Returns:

listResults

public SearchResults<K> listResults(Path<?>... paths)

listResults

public SearchResults<K> listResults()

Description copied from interface: SimpleProjectable

Get the projection in SearchResults form

Specified by:

listResults in interface SimpleProjectable<K>

Returns:

count

public long count()

Description copied from interface: SimpleProjectable

Get the count of matched elements

Specified by:

count in interface SimpleProjectable<K>

Returns:

setReadPreference

public void setReadPreference(com.mongodb.ReadPreference readPreference)

toString

public String toString()

Overrides:

toString in class Object