org.springframework.data.document.mongodb.query
Class Criteria

java.lang.Object
  org.springframework.data.document.mongodb.query.Criteria

All Implemented Interfaces:

CriteriaDefinition

public class Criteria
extends java.lang.Object
implements CriteriaDefinition

Constructor Summary

protected	Criteria(java.util.List<Criteria> criteriaChain, java.lang.String key)
	Criteria(java.lang.String key)

Method Summary

Criteria	all(java.lang.Object... o) Creates a criterion using the $all operator
Criteria	and(java.lang.String key) Static factory method to create a Criteria using the provided key
Criteria	elemMatch(Criteria c) Creates a criterion using the $elemMatch operator
Criteria	exists(boolean b) Creates a criterion using the $exists operator
com.mongodb.DBObject	getCriteriaObject()
java.lang.String	getKey()
protected com.mongodb.DBObject	getSingleCriteriaObject()
Criteria	gt(java.lang.Object o) Creates a criterion using the $gt operator
Criteria	gte(java.lang.Object o) Creates a criterion using the $gte operator
Criteria	in(java.util.Collection<?> c) Creates a criterion using the $in operator
Criteria	in(java.lang.Object... o) Creates a criterion using the $in operator
Criteria	is(java.lang.Object o) Creates a criterion using equality
Criteria	lt(java.lang.Object o) Creates a criterion using the $lt operator
Criteria	lte(java.lang.Object o) Creates a criterion using the $lte operator
Criteria	maxDistance(double maxDistance) Creates a geospatical criterion using a $maxDistance operation, for use with $near
Criteria	mod(java.lang.Number value, java.lang.Number remainder) Creates a criterion using the $mod operator
Criteria	ne(java.lang.Object o) Creates a criterion using the $ne operator
Criteria	near(Point point) Creates a geospatial criterion using a $near operation
Criteria	nearSphere(Point point) Creates a geospatial criterion using a $nearSphere operation.
Criteria	nin(java.lang.Object... o) Creates a criterion using the $nin operator
Criteria	not() Creates a criterion using the $not meta operator which affects the clause directly following
void	or(java.util.List<Query> queries) Creates an or query using the $or operator for all of the provided queries
Criteria	regex(java.lang.String re) Creates a criterion using a $regex
Criteria	size(int s) Creates a criterion using the $size operator
Criteria	type(int t) Creates a criterion using the $type operator
static Criteria	where(java.lang.String key) Static factory method to create a Criteria using the provided key
Criteria	withinBox(Box box) Creates a geospatial criterion using a $within $box operation
Criteria	withinCenter(Circle circle) Creates a geospatial criterion using a $within $center operation
Criteria	withinCenterSphere(Circle circle) Creates a geospatial criterion using a $within $center operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Criteria

public Criteria(java.lang.String key)

Criteria

protected Criteria(java.util.List<Criteria> criteriaChain,
                   java.lang.String key)

Method Detail

where

public static Criteria where(java.lang.String key)

Static factory method to create a Criteria using the provided key

Parameters:

key -

Returns:

and

public Criteria and(java.lang.String key)

Static factory method to create a Criteria using the provided key

Parameters:

key -

Returns:

is

public Criteria is(java.lang.Object o)

Creates a criterion using equality

Parameters:

o -

Returns:

ne

public Criteria ne(java.lang.Object o)

Creates a criterion using the $ne operator

Parameters:

o -

Returns:

lt

public Criteria lt(java.lang.Object o)

Creates a criterion using the $lt operator

Parameters:

o -

Returns:

lte

public Criteria lte(java.lang.Object o)

Creates a criterion using the $lte operator

Parameters:

o -

Returns:

gt

public Criteria gt(java.lang.Object o)

Creates a criterion using the $gt operator

Parameters:

o -

Returns:

gte

public Criteria gte(java.lang.Object o)

Creates a criterion using the $gte operator

Parameters:

o -

Returns:

in

public Criteria in(java.lang.Object... o)

Creates a criterion using the $in operator

Parameters:

o - the values to match against

Returns:

in

public Criteria in(java.util.Collection<?> c)

Creates a criterion using the $in operator

Parameters:

c - the collection containing the values to match against

Returns:

nin

public Criteria nin(java.lang.Object... o)

Creates a criterion using the $nin operator

Parameters:

o -

Returns:

mod

public Criteria mod(java.lang.Number value,
                    java.lang.Number remainder)

Creates a criterion using the $mod operator

Parameters:

value -

remainder -

Returns:

all

public Criteria all(java.lang.Object... o)

Creates a criterion using the $all operator

Parameters:

o -

Returns:

size

public Criteria size(int s)

Creates a criterion using the $size operator

Parameters:

s -

Returns:

exists

public Criteria exists(boolean b)

Creates a criterion using the $exists operator

Parameters:

b -

Returns:

type

public Criteria type(int t)

Creates a criterion using the $type operator

Parameters:

t -

Returns:

not

public Criteria not()

Creates a criterion using the $not meta operator which affects the clause directly following

Returns:

regex

public Criteria regex(java.lang.String re)

Creates a criterion using a $regex

Parameters:

re -

Returns:

withinCenter

public Criteria withinCenter(Circle circle)

Creates a geospatial criterion using a $within $center operation

Parameters:

circle - must not be null

Returns:

withinCenterSphere

public Criteria withinCenterSphere(Circle circle)

Creates a geospatial criterion using a $within $center operation. This is only available for Mongo 1.7 and higher.

Parameters:

circle - must not be null

Returns:

withinBox

public Criteria withinBox(Box box)

Creates a geospatial criterion using a $within $box operation

Parameters:

box -

Returns:

near

public Criteria near(Point point)

Creates a geospatial criterion using a $near operation

Parameters:

point - must not be null

Returns:

nearSphere

public Criteria nearSphere(Point point)

Creates a geospatial criterion using a $nearSphere operation. This is only available for Mongo 1.7 and higher.

Parameters:

point - must not be null

Returns:

maxDistance

public Criteria maxDistance(double maxDistance)

Creates a geospatical criterion using a $maxDistance operation, for use with $near

Parameters:

maxDistance -

Returns:

elemMatch

public Criteria elemMatch(Criteria c)

Creates a criterion using the $elemMatch operator

Parameters:

c -

Returns:

or

public void or(java.util.List<Query> queries)

Creates an or query using the $or operator for all of the provided queries

Parameters:

queries -

getKey

public java.lang.String getKey()

getCriteriaObject

public com.mongodb.DBObject getCriteriaObject()

Specified by:

getCriteriaObject in interface CriteriaDefinition

getSingleCriteriaObject

protected com.mongodb.DBObject getSingleCriteriaObject()