de.caluga.morphium

Interface Query<T>

All Superinterfaces:

Cloneable

All Known Implementing Classes:

QueryImpl

public interface Query<T>
extends Cloneable

User: Stpehan Bösebeck Date: 26.03.12 Time: 11:29

usage: Query q= Morphium.get().createQueryFor(UncachedObject.class); q=q.f("counter").lt(15).f("counter").gt(10); Or q.or(q.q().f("counter").eq(15),q.q().f("counter").eq(22)); AND is the default!

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(FilterExpression e) needed for creation of the query representation tree
List<T>	asList() the result as list
Query<T>	clone()
List<T>	complexQuery(com.mongodb.DBObject query)
List<T>	complexQuery(com.mongodb.DBObject query, Map<String,Integer> sort, int skip, int limit) just sends the given query to the MongoDBDriver and masrhalls objects as listed ignores all other query settings!!!!!
List<T>	complexQuery(com.mongodb.DBObject query, String sort, int skip, int limit)
T	complexQueryOne(com.mongodb.DBObject query) same as copmplexQuery(query,0,1).get(0);
T	complexQueryOne(com.mongodb.DBObject query, Map<String,Integer> sort)
T	complexQueryOne(com.mongodb.DBObject query, Map<String,Integer> sort, int skip)
long	countAll() count all results in query - does not take limit or skip into account
MongoField	f(Enum field) same as f(field.name())
MongoField	f(String f) Get a field.
T	get() get only 1 result (first one in result list)
T	getById(org.bson.types.ObjectId id) returns one object that matches to id
int	getLimit()
ObjectMapper	getMapper() get the current mapper implmenentation
Map<String,Integer>	getOrder()
ReadPreferenceLevel	getReadPreferenceLevel()
int	getSkip()
Class<T>	getType() what type this query is for
List<org.bson.types.ObjectId>	idList() only return the IDs of objects (useful if objects are really large)
Query<T>	limit(int i) limit the number of entries in result
void	nor(Query<T>... q) not or
void	or(Query<T>... q) concatenate those queries with or
Query<T>	order(Map<String,Integer> n) Deprecated.
Query<T>	order(String... prefixedString) Deprecated.
Query<T>	q() create a new empty query for the same type using the same mapper as this
void	setMapper(ObjectMapper mapper) set the object Mapper this query object should use.
void	setReadPreferenceLevel(ReadPreferenceLevel readPreferenceLevel)
void	setType(Class<T> type) what type to use
Query<T>	skip(int i) skip the first entries in result
Query<T>	sort(Enum... naturalOrder)
Query<T>	sort(Map<String,Integer> n) set an order - Key: FieldName (java or Mongo-Name), Value: Integer: -1 reverse, 1 standard
Query<T>	sort(String... prefixedString) set order by prefixing field names with - for reverse ordering (+ or nothing default)
com.mongodb.DBObject	toQueryObject() create a db object from this query and all of it's child nodes
Query<T>	where(String wh) set the where string for this query - where-String needs to be valid java script!

Method Detail

where

Query<T> where(String wh)

set the where string for this query - where-String needs to be valid java script! Errors will only be shown in MongoD-Log!

Parameters:

wh -

Returns:

f

MongoField f(String f)

Get a field. F may be the name as it is in mongo db or the variable name in java...

Parameters:

f -

Returns:

f

MongoField f(Enum field)

same as f(field.name())

Parameters:

field -

Returns:

or

void or(Query<T>... q)

concatenate those queries with or

Parameters:

q -

nor

void nor(Query<T>... q)

not or

Parameters:

q -

limit

Query<T> limit(int i)

limit the number of entries in result

Parameters:

i -

Returns:

skip

Query<T> skip(int i)

skip the first entries in result

Parameters:

i -

Returns:

sort

Query<T> sort(Map<String,Integer> n)

set an order - Key: FieldName (java or Mongo-Name), Value: Integer: -1 reverse, 1 standard

Parameters:

n -

Returns:

sort

Query<T> sort(String... prefixedString)

set order by prefixing field names with - for reverse ordering (+ or nothing default)

Parameters:

prefixedString -

Returns:

sort

Query<T> sort(Enum... naturalOrder)

order

Query<T> order(Map<String,Integer> n)

Deprecated.

set an order - Key: FieldName (java or Mongo-Name), Value: Integer: -1 reverse, 1 standard deprectaed, use sort instead (more like the maongodb-commands)... used for backward compatibility.

Parameters:

n -

Returns:

order

Query<T> order(String... prefixedString)

Deprecated.

set order by prefixing field names with - for reverse ordering (+ or nothing default) deprectaed, use sort instead (more like the maongodb-commands)... used for backward compatibility.

Parameters:

prefixedString -

Returns:

countAll

long countAll()

count all results in query - does not take limit or skip into account

Returns:

addChild

void addChild(FilterExpression e)

needed for creation of the query representation tree

Parameters:

e -

toQueryObject

com.mongodb.DBObject toQueryObject()

create a db object from this query and all of it's child nodes

Returns:

getType

Class<T> getType()

what type this query is for

Returns:

asList

List<T> asList()

the result as list

Returns:

get

T get()

get only 1 result (first one in result list)

Returns:

getById

T getById(org.bson.types.ObjectId id)

returns one object that matches to id

Parameters:

id - - should be the Unique ID

Returns:

- the object, if found, null otherwise

idList

List<org.bson.types.ObjectId> idList()

only return the IDs of objects (useful if objects are really large)

Returns:

setMapper

void setMapper(ObjectMapper mapper)

set the object Mapper this query object should use. By default this is set by Morphium-Class

Parameters:

mapper -

getMapper

ObjectMapper getMapper()

get the current mapper implmenentation

Returns:

setType

void setType(Class<T> type)

what type to use

Parameters:

type -

q

Query<T> q()

create a new empty query for the same type using the same mapper as this

Returns:

complexQuery

List<T> complexQuery(com.mongodb.DBObject query)

complexQuery

List<T> complexQuery(com.mongodb.DBObject query,
                   Map<String,Integer> sort,
                   int skip,
                   int limit)

just sends the given query to the MongoDBDriver and masrhalls objects as listed ignores all other query settings!!!!!

Parameters:

query - - query to be sent

skip - - amount to skip

limit - - maximium number of results

Returns:

list of objects matching query

complexQuery

List<T> complexQuery(com.mongodb.DBObject query,
                   String sort,
                   int skip,
                   int limit)

complexQueryOne

T complexQueryOne(com.mongodb.DBObject query)

same as copmplexQuery(query,0,1).get(0);

Parameters:

query -

Returns:

complexQueryOne

T complexQueryOne(com.mongodb.DBObject query,
                Map<String,Integer> sort,
                int skip)

complexQueryOne

T complexQueryOne(com.mongodb.DBObject query,
                Map<String,Integer> sort)

getLimit

int getLimit()

getSkip

int getSkip()

getOrder

Map<String,Integer> getOrder()

clone

Query<T> clone()
               throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getReadPreferenceLevel

ReadPreferenceLevel getReadPreferenceLevel()

setReadPreferenceLevel

void setReadPreferenceLevel(ReadPreferenceLevel readPreferenceLevel)