de.caluga.morphium.query

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!

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Query.TextSearchLanguages

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(FilterExpression e) needed for creation of the query representation tree
void	addReturnedField(Enum f)
void	addReturnedField(String f)
MorphiumIterator<T>	asIterable() create an iterator / iterable for this query, default windowSize (10), prefetch windows 1
MorphiumIterator<T>	asIterable(int windowSize) create an iterator / iterable for this query, sets window size (how many objects should be read from DB) prefetch number is 1 in this case
MorphiumIterator<T>	asIterable(int windowSize, int prefixWindows) create an iterator / iterable for this query, sets window size (how many entities are read en block) and how many windows of this size will be prefechted...
List<T>	asList() the result as list
void	asList(AsyncOperationCallback<T> callback)
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
void	countAll(AsyncOperationCallback<T> callback)
void	delete()
void	disableAutoValues()
List	distinct(String field)
void	enableAutoValues()
MongoField<T>	f(Enum... f)
MongoField<T>	f(Enum field) same as f(field.name())
MongoField<T>	f(String... f)
MongoField<T>	f(String f) Get a field.
T	get() get only 1 result (first one in result list)
void	get(AsyncOperationCallback<T> callback)
T	getById(Object id)
void	getById(Object id, AsyncOperationCallback<T> callback)
String	getCollectionName()
int	getLimit()
Morphium	getMorphium()
int	getNumberOfPendingRequests()
ReadPreferenceLevel	getReadPreferenceLevel()
com.mongodb.ServerAddress	getServer() returns the serveraddress the query was executed on
int	getSkip()
Map<String,Object>	getSort()
Class<? extends T>	getType() what type this query is for
String	getWhere()
<R> List<R>	idList() only return the IDs of objects (useful if objects are really large)
void	idList(AsyncOperationCallback<T> callback)
boolean	isAutoValuesEnabled()
Query<T>	limit(int i) limit the number of entries in result
Query<T>	nor(Query<T>... q) not or
Query<T>	or(List<Query<T>> q) concatenate those queries with or
Query<T>	or(Query<T>... q) concatenate those queries with or
Query<T>	q() create a new empty query for the same type using the same mapper as this
void	setAutoValuesEnabled(boolean autoValues)
void	setCollectionName(String n) use a different collection name for the query
void	setExecutor(ThreadPoolExecutor executor)
void	setMorphium(Morphium m)
void	setReadPreferenceLevel(ReadPreferenceLevel readPreferenceLevel)
void	setReturnedFields(Enum... fl)
void	setReturnedFields(String... fl)
void	setType(Class<? extends 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,Object> 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)
Query<T>	text(Query.TextSearchLanguages lang, String... text)
Query<T>	text(String... text)
Query<T>	text(String metaScoreField, Query.TextSearchLanguages lang, String... text)
List<T>	textSearch(Query.TextSearchLanguages lang, String... texts) Deprecated.
List<T>	textSearch(String... texts) Deprecated.
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 - where string

Returns:

where wuery

f

MongoField<T> 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 - field

Returns:

the field implementation

getServer

com.mongodb.ServerAddress getServer()

returns the serveraddress the query was executed on

Returns:

the serveraddress the query was executed on, null if not executed yet

f

MongoField<T> f(Enum field)

same as f(field.name())

Parameters:

field - field

Returns:

mongo field

or

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

concatenate those queries with or

Parameters:

q - query

or

Query<T> or(List<Query<T>> q)

concatenate those queries with or

Parameters:

q - query

nor

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

not or

Parameters:

q - query

limit

Query<T> limit(int i)

limit the number of entries in result

Parameters:

i - - limit

Returns:

the query

skip

Query<T> skip(int i)

skip the first entries in result

Parameters:

i - skip

Returns:

the query

sort

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

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

Parameters:

n - - sort

Returns:

the query

sort

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

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

Parameters:

prefixedString - sort

Returns:

the query

sort

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

countAll

long countAll()

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

Returns:

number

countAll

void countAll(AsyncOperationCallback<T> callback)

addChild

void addChild(FilterExpression e)

needed for creation of the query representation tree

Parameters:

e - expression

toQueryObject

com.mongodb.DBObject toQueryObject()

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

Returns:

query object

getType

Class<? extends T> getType()

what type this query is for

Returns:

class

asList

List<T> asList()

the result as list

Returns:

list

asList

void asList(AsyncOperationCallback<T> callback)

asIterable

MorphiumIterator<T> asIterable()

create an iterator / iterable for this query, default windowSize (10), prefetch windows 1

asIterable

MorphiumIterator<T> asIterable(int windowSize)

create an iterator / iterable for this query, sets window size (how many objects should be read from DB) prefetch number is 1 in this case

asIterable

MorphiumIterator<T> asIterable(int windowSize,
                             int prefixWindows)

create an iterator / iterable for this query, sets window size (how many entities are read en block) and how many windows of this size will be prefechted...

Parameters:

windowSize -

prefixWindows -

Returns:

get

T get()

get only 1 result (first one in result list)

Returns:

entity

get

void get(AsyncOperationCallback<T> callback)

idList

<R> List<R> idList()

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

Returns:

list of Ids, type R

idList

void idList(AsyncOperationCallback<T> callback)

setType

void setType(Class<? extends T> type)

what type to use

Parameters:

type - type

q

Query<T> q()

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

Returns:

query

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 - - query

Returns:

type

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

getSort

Map<String,Object> getSort()

clone

Query<T> clone()
               throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getReadPreferenceLevel

ReadPreferenceLevel getReadPreferenceLevel()

setReadPreferenceLevel

void setReadPreferenceLevel(ReadPreferenceLevel readPreferenceLevel)

getWhere

String getWhere()

getMorphium

Morphium getMorphium()

setMorphium

void setMorphium(Morphium m)

setExecutor

void setExecutor(ThreadPoolExecutor executor)

getById

void getById(Object id,
           AsyncOperationCallback<T> callback)

getById

T getById(Object id)

getNumberOfPendingRequests

int getNumberOfPendingRequests()

setCollectionName

void setCollectionName(String n)

use a different collection name for the query

Parameters:

n -

getCollectionName

String getCollectionName()

textSearch

@Deprecated
List<T> textSearch(String... texts)

Deprecated.

textSearch

@Deprecated
List<T> textSearch(Query.TextSearchLanguages lang,
                            String... texts)

Deprecated.

f

MongoField<T> f(Enum... f)

f

MongoField<T> f(String... f)

delete

void delete()

setAutoValuesEnabled

void setAutoValuesEnabled(boolean autoValues)

isAutoValuesEnabled

boolean isAutoValuesEnabled()

disableAutoValues

void disableAutoValues()

enableAutoValues

void enableAutoValues()

text

Query<T> text(String... text)

text

Query<T> text(Query.TextSearchLanguages lang,
            String... text)

text

Query<T> text(String metaScoreField,
            Query.TextSearchLanguages lang,
            String... text)

setReturnedFields

void setReturnedFields(String... fl)

addReturnedField

void addReturnedField(String f)

setReturnedFields

void setReturnedFields(Enum... fl)

addReturnedField

void addReturnedField(Enum f)

distinct

List distinct(String field)