Query (morphia 0.105 API)

All Superinterfaces:

Cloneable, Iterable<T>, QueryResults<T>

All Known Implementing Classes:

QueryImpl
```
public interface Query<T>
extends QueryResults<T>, Cloneable
```

Method Summary

Methods
Modifier and Type	Method and Description
`CriteriaContainer`	`and(Criteria... criteria)`
`Query<T>`	`batchSize(int value)` Batch-size of the fetched result (cursor).
`Query<T>`	`clone()` Creates and returns a copy of this `Query`.
`FieldEnd<? extends CriteriaContainerImpl>`	`criteria(String field)` Criteria builder interface
`Query<T>`	`disableCursorTimeout()` Disables cursor timeout on server.
`Query<T>`	`disableSnapshotMode()` Disable snapshotted mode (default mode).
`Query<T>`	`disableValidation()` Turns off validation (for all calls made after)
`Query<T>`	`enableCursorTimeout()` Enables cursor timeout on server.
`Query<T>`	`enableSnapshotMode()` Enabled snapshotted mode where duplicate results (which may be updated during the lifetime of the cursor) will not be returned.
`Query<T>`	`enableValidation()` Turns on validation (for all calls made after); by default validation is on
`FieldEnd<? extends Query<T>>`	`field(String field)` Fluent query interface: `createQuery(Ent.class).field("count").greaterThan(7)...`
`Query<T>`	`filter(String condition, Object value)` Create a filter based on the specified condition and value.
`int`	`getBatchSize()` Returns the batch size
`com.mongodb.DBCollection`	`getCollection()` Returns the `DBCollection` of the `Query`.
`Class<T>`	`getEntityClass()` Returns the entity `Class`.
`com.mongodb.DBObject`	`getFieldsObject()` Returns the Mongo fields `DBObject`.
`int`	`getLimit()` Returns the limit
`int`	`getOffset()` Returns the offset.
`com.mongodb.DBObject`	`getQueryObject()` Returns the Mongo query `DBObject`.
`com.mongodb.DBObject`	`getSortObject()` Returns the Mongo sort `DBObject`.
`Query<T>`	`hintIndex(String idxName)` Hints as to which index should be used.
`Query<T>`	`limit(int value)` Limit the fetched result set to a certain number of values.
`Query<T>`	`offset(int value)` Starts the query results at a particular zero-based offset.
`CriteriaContainer`	`or(Criteria... criteria)`
`Query<T>`	`order(String condition)` Sorts based on a property (defines return order).
`Query<T>`	`queryNonPrimary()` Route query to non-primary node
`Query<T>`	`queryPrimaryOnly()` Route query to primary node
`Query<T>`	`retrievedFields(boolean include, String... fields)` Limits the fields retrieved
`Query<T>`	`retrieveKnownFields()` Limits the fields retrieved to those of the query type -- dangerous with interfaces and abstract classes
`Query<T>`	`skip(int value)` Deprecated. use @{link #offset(int)} instead
`String`	`toString()` Generates a string that consistently and uniquely specifies this query.
`Query<T>`	`useReadPreference(com.mongodb.ReadPreference readPref)` Route query ReadPreference
`Query<T>`	`where(org.bson.types.CodeWScope js)` Limit the query using this javascript block; only one per query
`Query<T>`	`where(String js)` Limit the query using this javascript block; only one per query

Methods inherited from interface org.mongodb.morphia.query.QueryResults
asKeyList, asList, countAll, fetch, fetchEmptyEntities, fetchKeys, get, getKey, tail, tail

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - filter
```
Query<T> filter(String condition,
              Object value)
```
    Create a filter based on the specified condition and value.
    
    Note: Property is in the form of "name op" ("age >").
    
    Valid operators are ["=", "==","!=", "<>", ">", "<", ">=", "<=", "in", "nin", "all", "size", "exists"]
    
    Examples:
    - filter("yearsOfOperation >", 5)
    - filter("rooms.maxBeds >=", 2)
    - filter("rooms.bathrooms exists", 1)
    - filter("stars in", new Long[]{3, 4}) //3 and 4 stars (midrange?)
    - filter("quantity mod", new Long[]{4, 0}) // customers ordered in packs of 4)
    - filter("age >=", age)
    - filter("age =", age)
    - filter("age", age) (if no operator, = is assumed)
    - filter("age !=", age)
    - filter("age in", ageList)
    - filter("customers.loyaltyYears in", yearsList)
    You can filter on id properties if this query is restricted to a Class.
  - field
```
FieldEnd<? extends Query<T>> field(String field)
```
    Fluent query interface: createQuery(Ent.class).field("count").greaterThan(7)...
  - criteria
```
FieldEnd<? extends CriteriaContainerImpl> criteria(String field)
```
    Criteria builder interface
  - and
```
CriteriaContainer and(Criteria... criteria)
```
  - or
```
CriteriaContainer or(Criteria... criteria)
```
  - where
```
Query<T> where(String js)
```
    Limit the query using this javascript block; only one per query
  - where
```
Query<T> where(org.bson.types.CodeWScope js)
```
    Limit the query using this javascript block; only one per query
  - order
```
Query<T> order(String condition)
```
    Sorts based on a property (defines return order). Examples:
    - order("age")
    - order("-age") (descending order)
    - order("age, date")
    - order("age,-date") (age ascending, date descending)
  - limit
```
Query<T> limit(int value)
```
    Limit the fetched result set to a certain number of values.
    
    Parameters:
    value - must be >= 0. A value of 0 indicates no limit.
  - batchSize
```
Query<T> batchSize(int value)
```
    Batch-size of the fetched result (cursor).
    
    Parameters:
    value - must be >= 0. A value of 0 indicates the server default.
  - offset
```
Query<T> offset(int value)
```
    Starts the query results at a particular zero-based offset.
    
    Parameters:
    value - must be >= 0
  - skip
```
Query<T> skip(int value)
```
    Deprecated. use @{link #offset(int)} instead
    
    Parameters:
    value -
    
    Returns:
  - enableValidation
```
Query<T> enableValidation()
```
    Turns on validation (for all calls made after); by default validation is on
  - disableValidation
```
Query<T> disableValidation()
```
    Turns off validation (for all calls made after)
  - hintIndex
```
Query<T> hintIndex(String idxName)
```
    Hints as to which index should be used.
  - retrievedFields
```
Query<T> retrievedFields(boolean include,
                       String... fields)
```
    Limits the fields retrieved
  - retrieveKnownFields
```
Query<T> retrieveKnownFields()
```
    Limits the fields retrieved to those of the query type -- dangerous with interfaces and abstract classes
  - enableSnapshotMode
```
Query<T> enableSnapshotMode()
```
    Enabled snapshotted mode where duplicate results (which may be updated during the lifetime of the cursor) will not be returned. Not compatible with order/sort and hint. *
  - disableSnapshotMode
```
Query<T> disableSnapshotMode()
```
    Disable snapshotted mode (default mode). This will be faster but changes made during the cursor may cause duplicates. *
  - queryNonPrimary
```
Query<T> queryNonPrimary()
```
    Route query to non-primary node
  - queryPrimaryOnly
```
Query<T> queryPrimaryOnly()
```
    Route query to primary node
  - useReadPreference
```
Query<T> useReadPreference(com.mongodb.ReadPreference readPref)
```
    Route query ReadPreference
  - disableCursorTimeout
```
Query<T> disableCursorTimeout()
```
    Disables cursor timeout on server.
  - enableCursorTimeout
```
Query<T> enableCursorTimeout()
```
    Enables cursor timeout on server.
  - toString
```
String toString()
```
    Generates a string that consistently and uniquely specifies this query. There is no way to convert this string back into a query and there is no guarantee that the string will be consistent across versions.
    
    In particular, this value is useful as a key for a simple memcache query cache.
    
    Overrides:
    
    toString in class Object
  - getEntityClass
```
Class<T> getEntityClass()
```
    Returns the entity Class.
  - getOffset
```
int getOffset()
```
    Returns the offset.
    
    See Also:
    offset(int)
  - getLimit
```
int getLimit()
```
    Returns the limit
    
    See Also:
    limit(int)
  - getBatchSize
```
int getBatchSize()
```
    Returns the batch size
    
    See Also:
    batchSize(int)
  - getQueryObject
```
com.mongodb.DBObject getQueryObject()
```
    Returns the Mongo query DBObject.
  - getSortObject
```
com.mongodb.DBObject getSortObject()
```
    Returns the Mongo sort DBObject.
  - getFieldsObject
```
com.mongodb.DBObject getFieldsObject()
```
    Returns the Mongo fields DBObject.
  - getCollection
```
com.mongodb.DBCollection getCollection()
```
    Returns the DBCollection of the Query.
  - clone
```
Query<T> clone()
```
    Creates and returns a copy of this Query.

Interface Query<T>

Method Summary

Methods inherited from interface org.mongodb.morphia.query.QueryResults

Methods inherited from interface java.lang.Iterable

Method Detail

filter

field

criteria

and

or

where

where

order

limit

batchSize

offset

skip

enableValidation

disableValidation

hintIndex

retrievedFields

retrieveKnownFields

enableSnapshotMode

disableSnapshotMode

queryNonPrimary

queryPrimaryOnly

useReadPreference

disableCursorTimeout

enableCursorTimeout

toString

getEntityClass

getOffset

getLimit

getBatchSize

getQueryObject

getSortObject

getFieldsObject

getCollection

clone