QueryImpl (Morphium 2.2.23 API)

java.lang.Object
- de.caluga.morphium.query.QueryImpl<T>

All Implemented Interfaces:

Query<T>, Cloneable
```
public class QueryImpl<T>
extends Object
implements Query<T>, Cloneable
```
User: Stpehan Bösebeck Date: 26.03.12 Time: 22:14

Nested Class Summary
- Nested classes/interfaces inherited from interface de.caluga.morphium.query.Query
  Query.TextSearchLanguages

Constructor Summary

Constructors
Constructor and Description

QueryImpl()

QueryImpl(Morphium m)

QueryImpl(Morphium m, Class<? extends T> type, ThreadPoolExecutor executor)

Constructors
Constructor and Description
`QueryImpl()`
`QueryImpl(Morphium m)`
`QueryImpl(Morphium m, Class<? extends T> type, ThreadPoolExecutor executor)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(FilterExpression ex)` needed for creation of the query representation tree
`void`	`addReturnedField(Enum f)`
`void`	`addReturnedField(String f)`
`MorphiumIterator<T>`	`asCustomIterable(int windowSize, Class<? extends MorphiumIterator<T>> it)`
`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> c)`
`void`	`delete()`
`void`	`disableAutoValues()`
`List`	`distinct(String field)`
`void`	`enableAutoValues()`
`MongoField<T>`	`f(Enum... f)`
`MongoField<T>`	`f(Enum f)` 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()`
`ThreadPoolExecutor`	`getExecutor()`
`int`	`getLimit()`
`Morphium`	`getMorphium()`
`int`	`getNumberOfPendingRequests()`
`com.mongodb.ReadPreference`	`getReadPreference()` retrun mongo's readPreference
`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>... qs)` not or
`Query<T>`	`or(List<Query<T>> qs)` concatenate those queries with or
`Query<T>`	`or(Query<T>... qs)` 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 autoValuesEnabled)`
`void`	`setCollectionName(String n)` use a different collection name for the query
`void`	`setExecutor(ThreadPoolExecutor executor)`
`void`	`setMorphium(Morphium m)`
`void`	`setReadPreference(com.mongodb.ReadPreference readPreference)`
`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)` this does not check for existence of the Field!
`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
`String`	`toString()`
`Query<T>`	`where(String wh)` set the where string for this query - where-String needs to be valid java script!

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - QueryImpl
```
public QueryImpl()
```
  - QueryImpl
```
public QueryImpl(Morphium m,
         Class<? extends T> type,
         ThreadPoolExecutor executor)
```
  - QueryImpl
```
public QueryImpl(Morphium m)
```
- Method Detail
  - disableAutoValues
```
public void disableAutoValues()
```
    Specified by:
    
    disableAutoValues in interface Query<T>
  - enableAutoValues
```
public void enableAutoValues()
```
    Specified by:
    
    enableAutoValues in interface Query<T>
  - isAutoValuesEnabled
```
public boolean isAutoValuesEnabled()
```
    Specified by:
    
    isAutoValuesEnabled in interface Query<T>
  - setAutoValuesEnabled
```
public void setAutoValuesEnabled(boolean autoValuesEnabled)
```
    Specified by:
    
    setAutoValuesEnabled in interface Query<T>
  - getServer
```
public com.mongodb.ServerAddress getServer()
```
    Description copied from interface: Query
    
    returns the serveraddress the query was executed on
    
    Specified by:
    
    getServer in interface Query<T>
    
    Returns:
    the serveraddress the query was executed on, null if not executed yet
  - getExecutor
```
public ThreadPoolExecutor getExecutor()
```
  - setExecutor
```
public void setExecutor(ThreadPoolExecutor executor)
```
    Specified by:
    
    setExecutor in interface Query<T>
  - getWhere
```
public String getWhere()
```
    Specified by:
    
    getWhere in interface Query<T>
  - getMorphium
```
public Morphium getMorphium()
```
    Specified by:
    
    getMorphium in interface Query<T>
  - setMorphium
```
public void setMorphium(Morphium m)
```
    Specified by:
    
    setMorphium in interface Query<T>
  - getReadPreferenceLevel
```
public ReadPreferenceLevel getReadPreferenceLevel()
```
    Specified by:
    
    getReadPreferenceLevel in interface Query<T>
  - setReadPreferenceLevel
```
public void setReadPreferenceLevel(ReadPreferenceLevel readPreferenceLevel)
```
    Specified by:
    
    setReadPreferenceLevel in interface Query<T>
  - q
```
public Query<T> q()
```
    Description copied from interface: Query
    
    create a new empty query for the same type using the same mapper as this
    
    Specified by:
    
    q in interface Query<T>
    
    Returns:
    query
  - complexQuery
```
public List<T> complexQuery(com.mongodb.DBObject query)
```
    Specified by:
    
    complexQuery in interface Query<T>
  - complexQuery
```
public List<T> complexQuery(com.mongodb.DBObject query,
                   String sort,
                   int skip,
                   int limit)
```
    Specified by:
    
    complexQuery in interface Query<T>
  - complexQuery
```
public List<T> complexQuery(com.mongodb.DBObject query,
                   Map<String,Integer> sort,
                   int skip,
                   int limit)
```
    Description copied from interface: Query
    
    just sends the given query to the MongoDBDriver and masrhalls objects as listed ignores all other query settings!!!!!
    
    Specified by:
    
    complexQuery in interface Query<T>
    
    Parameters:
    query - - query to be sent
    skip - - amount to skip
    limit - - maximium number of results
    
    Returns:
    list of objects matching query
  - distinct
```
public List distinct(String field)
```
    Specified by:
    
    distinct in interface Query<T>
  - complexQueryOne
```
public T complexQueryOne(com.mongodb.DBObject query)
```
    Description copied from interface: Query
    
    same as copmplexQuery(query,0,1).get(0);
    
    Specified by:
    
    complexQueryOne in interface Query<T>
    
    Parameters:
    query - - query
    
    Returns:
    type
  - complexQueryOne
```
public T complexQueryOne(com.mongodb.DBObject query,
                Map<String,Integer> sort,
                int skip)
```
    Specified by:
    
    complexQueryOne in interface Query<T>
  - complexQueryOne
```
public T complexQueryOne(com.mongodb.DBObject query,
                Map<String,Integer> sort)
```
    Specified by:
    
    complexQueryOne in interface Query<T>
  - getLimit
```
public int getLimit()
```
    Specified by:
    
    getLimit in interface Query<T>
  - getSkip
```
public int getSkip()
```
    Specified by:
    
    getSkip in interface Query<T>
  - getSort
```
public Map<String,Object> getSort()
```
    Specified by:
    
    getSort in interface Query<T>
  - addChild
```
public void addChild(FilterExpression ex)
```
    Description copied from interface: Query
    
    needed for creation of the query representation tree
    
    Specified by:
    
    addChild in interface Query<T>
    
    Parameters:
    ex - expression
  - where
```
public Query<T> where(String wh)
```
    Description copied from interface: Query
    
    set the where string for this query - where-String needs to be valid java script! Errors will only be shown in MongoD-Log!
    
    Specified by:
    
    where in interface Query<T>
    
    Parameters:
    wh - where string
    
    Returns:
    where wuery
  - f
```
public MongoField<T> f(Enum f)
```
    Description copied from interface: Query
    
    same as f(field.name())
    
    Specified by:
    
    f in interface Query<T>
    
    Parameters:
    f - field
    
    Returns:
    mongo field
  - f
```
public MongoField<T> f(String... f)
```
    Specified by:
    
    f in interface Query<T>
  - f
```
public MongoField<T> f(Enum... f)
```
    Specified by:
    
    f in interface Query<T>
  - f
```
public MongoField<T> f(String f)
```
    Description copied from interface: Query
    
    Get a field. F may be the name as it is in mongo db or the variable name in java...
    
    Specified by:
    
    f in interface Query<T>
    
    Parameters:
    f - field
    
    Returns:
    the field implementation
  - or
```
@SafeVarargs
public final Query<T> or(Query<T>... qs)
```
    Description copied from interface: Query
    
    concatenate those queries with or
    
    Specified by:
    
    or in interface Query<T>
    
    Parameters:
    qs - query
  - or
```
public Query<T> or(List<Query<T>> qs)
```
    Description copied from interface: Query
    
    concatenate those queries with or
    
    Specified by:
    
    or in interface Query<T>
    
    Parameters:
    qs - query
  - nor
```
@SafeVarargs
public final Query<T> nor(Query<T>... qs)
```
    Description copied from interface: Query
    
    not or
    
    Specified by:
    
    nor in interface Query<T>
    
    Parameters:
    qs - query
  - limit
```
public Query<T> limit(int i)
```
    Description copied from interface: Query
    
    limit the number of entries in result
    
    Specified by:
    
    limit in interface Query<T>
    
    Parameters:
    i - - limit
    
    Returns:
    the query
  - skip
```
public Query<T> skip(int i)
```
    Description copied from interface: Query
    
    skip the first entries in result
    
    Specified by:
    
    skip in interface Query<T>
    
    Parameters:
    i - skip
    
    Returns:
    the query
  - sort
```
public Query<T> sort(Map<String,Object> n)
```
    this does not check for existence of the Field! Key in the map can be any text
    
    Specified by:
    
    sort in interface Query<T>
    
    Parameters:
    n -
    
    Returns:
  - sort
```
public Query<T> sort(String... prefixedString)
```
    Description copied from interface: Query
    
    set order by prefixing field names with - for reverse ordering (+ or nothing default)
    
    Specified by:
    
    sort in interface Query<T>
    
    Parameters:
    prefixedString - sort
    
    Returns:
    the query
  - sort
```
public Query<T> sort(Enum... naturalOrder)
```
    Specified by:
    
    sort in interface Query<T>
  - countAll
```
public void countAll(AsyncOperationCallback<T> c)
```
    Specified by:
    
    countAll in interface Query<T>
  - countAll
```
public long countAll()
```
    Description copied from interface: Query
    
    count all results in query - does not take limit or skip into account
    
    Specified by:
    
    countAll in interface Query<T>
    
    Returns:
    number
  - getReadPreference
```
public com.mongodb.ReadPreference getReadPreference()
```
    retrun mongo's readPreference
    
    Returns:
  - setReadPreference
```
public void setReadPreference(com.mongodb.ReadPreference readPreference)
```
  - toQueryObject
```
public com.mongodb.DBObject toQueryObject()
```
    Description copied from interface: Query
    
    create a db object from this query and all of it's child nodes
    
    Specified by:
    
    toQueryObject in interface Query<T>
    
    Returns:
    query object
  - getType
```
public Class<? extends T> getType()
```
    Description copied from interface: Query
    
    what type this query is for
    
    Specified by:
    
    getType in interface Query<T>
    
    Returns:
    class
  - setType
```
public void setType(Class<? extends T> type)
```
    Description copied from interface: Query
    
    what type to use
    
    Specified by:
    
    setType in interface Query<T>
    
    Parameters:
    type - type
  - asList
```
public void asList(AsyncOperationCallback<T> callback)
```
    Specified by:
    
    asList in interface Query<T>
  - asList
```
public List<T> asList()
```
    Description copied from interface: Query
    
    the result as list
    
    Specified by:
    
    asList in interface Query<T>
    
    Returns:
    list
  - asIterable
```
public MorphiumIterator<T> asIterable()
```
    Description copied from interface: Query
    
    create an iterator / iterable for this query, default windowSize (10), prefetch windows 1
    
    Specified by:
    
    asIterable in interface Query<T>
  - asCustomIterable
```
public MorphiumIterator<T> asCustomIterable(int windowSize,
                                   Class<? extends MorphiumIterator<T>> it)
```
    Specified by:
    
    asCustomIterable in interface Query<T>
  - asIterable
```
public MorphiumIterator<T> asIterable(int windowSize)
```
    Description copied from interface: Query
    
    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
    
    Specified by:
    
    asIterable in interface Query<T>
  - asIterable
```
public MorphiumIterator<T> asIterable(int windowSize,
                             int prefixWindows)
```
    Description copied from interface: Query
    
    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...
    
    Specified by:
    
    asIterable in interface Query<T>
    
    Returns:
  - getById
```
public void getById(Object id,
           AsyncOperationCallback<T> callback)
```
    Specified by:
    
    getById in interface Query<T>
  - getById
```
public T getById(Object id)
```
    Specified by:
    
    getById in interface Query<T>
  - get
```
public void get(AsyncOperationCallback<T> callback)
```
    Specified by:
    
    get in interface Query<T>
  - get
```
public T get()
```
    Description copied from interface: Query
    
    get only 1 result (first one in result list)
    
    Specified by:
    
    get in interface Query<T>
    
    Returns:
    entity
  - idList
```
public void idList(AsyncOperationCallback<T> callback)
```
    Specified by:
    
    idList in interface Query<T>
  - idList
```
public <R> List<R> idList()
```
    Description copied from interface: Query
    
    only return the IDs of objects (useful if objects are really large)
    
    Specified by:
    
    idList in interface Query<T>
    
    Returns:
    list of Ids, type R
  - clone
```
public Query<T> clone()
               throws CloneNotSupportedException
```
    Specified by:
    
    clone in interface Query<T>
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - delete
```
public void delete()
```
    Specified by:
    
    delete in interface Query<T>
  - getNumberOfPendingRequests
```
public int getNumberOfPendingRequests()
```
    Specified by:
    
    getNumberOfPendingRequests in interface Query<T>
  - getCollectionName
```
public String getCollectionName()
```
    Specified by:
    
    getCollectionName in interface Query<T>
  - setCollectionName
```
public void setCollectionName(String n)
```
    Description copied from interface: Query
    
    use a different collection name for the query
    
    Specified by:
    
    setCollectionName in interface Query<T>
  - text
```
public Query<T> text(String... text)
```
    Specified by:
    
    text in interface Query<T>
  - text
```
public Query<T> text(Query.TextSearchLanguages lang,
            String... text)
```
    Specified by:
    
    text in interface Query<T>
  - text
```
public Query<T> text(String metaScoreField,
            Query.TextSearchLanguages lang,
            String... text)
```
    Specified by:
    
    text in interface Query<T>
  - textSearch
```
@Deprecated
public List<T> textSearch(String... texts)
```
    Deprecated.
    
    Specified by:
    
    textSearch in interface Query<T>
  - textSearch
```
@Deprecated
public List<T> textSearch(Query.TextSearchLanguages lang,
                            String... texts)
```
    Deprecated.
    
    Specified by:
    
    textSearch in interface Query<T>
  - setReturnedFields
```
public void setReturnedFields(Enum... fl)
```
    Specified by:
    
    setReturnedFields in interface Query<T>
  - setReturnedFields
```
public void setReturnedFields(String... fl)
```
    Specified by:
    
    setReturnedFields in interface Query<T>
  - addReturnedField
```
public void addReturnedField(Enum f)
```
    Specified by:
    
    addReturnedField in interface Query<T>
  - addReturnedField
```
public void addReturnedField(String f)
```
    Specified by:
    
    addReturnedField in interface Query<T>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class QueryImpl<T>

Nested Class Summary

Nested classes/interfaces inherited from interface de.caluga.morphium.query.Query

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryImpl

QueryImpl

QueryImpl

Method Detail

disableAutoValues

enableAutoValues

isAutoValuesEnabled

setAutoValuesEnabled

getServer

getExecutor

setExecutor

getWhere

getMorphium

setMorphium

getReadPreferenceLevel

setReadPreferenceLevel

q

complexQuery

complexQuery

complexQuery

distinct

complexQueryOne

complexQueryOne

complexQueryOne

getLimit

getSkip

getSort

addChild

where

f

f

f

f

or

or

nor

limit

skip

sort

sort

sort

countAll

countAll

getReadPreference

setReadPreference

toQueryObject

getType

setType

asList

asList

asIterable

asCustomIterable

asIterable

asIterable

getById

getById

get

get

idList

idList

clone

delete

getNumberOfPendingRequests

getCollectionName

setCollectionName

text

text

text

textSearch

textSearch

setReturnedFields

setReturnedFields

addReturnedField