com.mongodb
Class QueryBuilder

java.lang.Object
  com.mongodb.QueryBuilder

public class QueryBuilder
extends Object

Utility for creating DBObject queries

Author:

Julson Lim

Constructor Summary

QueryBuilder()

Method Summary

QueryBuilder	all(Object object) Equivalent of the $all operand
QueryBuilder	and(String key) Equivalent to QueryBuilder.put(key).
QueryBuilder	exists(Object object) Equivalent of the $exists operand
DBObject	get() Creates a DBObject query to be used for the driver's find operations
QueryBuilder	greaterThan(Object object) Equivalent to the $gt operator
QueryBuilder	greaterThanEquals(Object object) Equivalent to the $gte operator
QueryBuilder	in(Object object) Equivalent of the $in operand
QueryBuilder	is(Object object) Equivalent of the find({key:value})
QueryBuilder	lessThan(Object object) Equivalent to the $lt operand
QueryBuilder	lessThanEquals(Object object) Equivalent to the $lte operand
QueryBuilder	mod(Object object) Equivalent of the $mod operand
QueryBuilder	near(double x, double y)
QueryBuilder	near(double x, double y, double maxDistance)
QueryBuilder	notEquals(Object object) Equivalent of the $ne operand
QueryBuilder	notIn(Object object) Equivalent of the $nin operand
QueryBuilder	put(String key) Adds a new key to the query or sets an existing key to as current for chaining
QueryBuilder	regex(Pattern regex) Passes a regular expression for a query
QueryBuilder	size(Object object) Equivalent of the $size operand
static QueryBuilder	start(String key) Creates a new query with a document key
QueryBuilder	withinCenter(double x, double y, double radius)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBuilder

public QueryBuilder()

Method Detail

start

public static QueryBuilder start(String key)

Creates a new query with a document key

Parameters:

key - MongoDB document key

Returns:

Returns a new QueryBuilder

put

public QueryBuilder put(String key)

Adds a new key to the query or sets an existing key to as current for chaining

Parameters:

key - MongoDB document key

Returns:

Returns the current QueryBuilder with an appended key operand

and

public QueryBuilder and(String key)

Equivalent to QueryBuilder.put(key). Intended for compound query chains to be more readable Example: QueryBuilder.start("a").greaterThan(1).and("b").lessThan(3)

Parameters:

key - MongoDB document key

Returns:

Returns the current QueryBuilder with an appended key operand

greaterThan

public QueryBuilder greaterThan(Object object)

Equivalent to the $gt operator

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "greater than" query

greaterThanEquals

public QueryBuilder greaterThanEquals(Object object)

Equivalent to the $gte operator

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "greater than or equals" query

lessThan

public QueryBuilder lessThan(Object object)

Equivalent to the $lt operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "less than" query

lessThanEquals

public QueryBuilder lessThanEquals(Object object)

Equivalent to the $lte operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "less than or equals" query

is

public QueryBuilder is(Object object)

Equivalent of the find({key:value})

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended equality query

notEquals

public QueryBuilder notEquals(Object object)

Equivalent of the $ne operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended inequality query

in

public QueryBuilder in(Object object)

Equivalent of the $in operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "in array" query

notIn

public QueryBuilder notIn(Object object)

Equivalent of the $nin operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "not in array" query

mod

public QueryBuilder mod(Object object)

Equivalent of the $mod operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended modulo query

all

public QueryBuilder all(Object object)

Equivalent of the $all operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended "matches all array contents" query

size

public QueryBuilder size(Object object)

Equivalent of the $size operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended size operator

exists

public QueryBuilder exists(Object object)

Equivalent of the $exists operand

Parameters:

object - Value to query

Returns:

Returns the current QueryBuilder with an appended exists operator

regex

public QueryBuilder regex(Pattern regex)

Passes a regular expression for a query

Parameters:

regex - Regex pattern object

Returns:

Returns the current QueryBuilder with an appended regex query

withinCenter

public QueryBuilder withinCenter(double x,
                                 double y,
                                 double radius)

near

public QueryBuilder near(double x,
                         double y)

near

public QueryBuilder near(double x,
                         double y,
                         double maxDistance)

get

public DBObject get()

Creates a DBObject query to be used for the driver's find operations

Returns:

Returns a DBObject query instance

Throws:

RuntimeException - if a key does not have a matching operand