Spring Data Document

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

java.lang.Object
  extended by org.springframework.data.mongodb.core.query.Criteria
All Implemented Interfaces:
CriteriaDefinition
Direct Known Subclasses:
GridFsCriteria

public class Criteria
extends Object
implements CriteriaDefinition

Central class for creating queries. It follows a fluent API style so that you can easily chain together multiple criteria. Static import of the 'Criteria.where' method will improve readability.


Constructor Summary
  Criteria()
           
protected Criteria(List<Criteria> criteriaChain, String key)
           
  Criteria(String key)
           
 
Method Summary
 Criteria all(Collection<?> o)
           
 Criteria all(Object... o)
          Creates a criterion using the $all operator
 Criteria and(String key)
          Static factory method to create a Criteria using the provided key
 Criteria andOperator(Criteria... criteria)
          Creates an 'and' criteria using the $and operator for all of the provided criteria
 Criteria elemMatch(Criteria c)
          Creates a criterion using the $elemMatch operator
 Criteria exists(boolean b)
          Creates a criterion using the $exists operator
 DBObject getCriteriaObject()
           
 String getKey()
           
protected  DBObject getSingleCriteriaObject()
           
 Criteria gt(Object o)
          Creates a criterion using the $gt operator
 Criteria gte(Object o)
          Creates a criterion using the $gte operator
 Criteria in(Collection<?> c)
          Creates a criterion using the $in operator
 Criteria in(Object... o)
          Creates a criterion using the $in operator
 Criteria is(Object o)
          Creates a criterion using equality
 Criteria lt(Object o)
          Creates a criterion using the $lt operator
 Criteria lte(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(Number value, Number remainder)
          Creates a criterion using the $mod operator
 Criteria ne(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(Collection<?> o)
           
 Criteria nin(Object... o)
          Creates a criterion using the $nin operator
 Criteria norOperator(Criteria... criteria)
          Creates a 'nor' criteria using the $nor operator for all of the provided criteria
 Criteria not()
          Creates a criterion using the $not meta operator which affects the clause directly following
 Criteria orOperator(Criteria... criteria)
          Creates an 'or' criteria using the $or operator for all of the provided criteria
 Criteria regex(Pattern pattern)
          Syntactical sugar for is(Object) making obvious that we create a regex predicate.
 Criteria regex(String re)
          Creates a criterion using a $regex
 Criteria regex(String re, String options)
          Creates a criterion using a $regex and $options
 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(String key)
          Static factory method to create a Criteria using the provided key
 Criteria within(Shape shape)
           
 Criteria withinSphere(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()

Criteria

public Criteria(String key)

Criteria

protected Criteria(List<Criteria> criteriaChain,
                   String key)
Method Detail

where

public static Criteria where(String key)
Static factory method to create a Criteria using the provided key

Parameters:
key -
Returns:

and

public Criteria and(String key)
Static factory method to create a Criteria using the provided key

Returns:

is

public Criteria is(Object o)
Creates a criterion using equality

Parameters:
o -
Returns:

ne

public Criteria ne(Object o)
Creates a criterion using the $ne operator

Parameters:
o -
Returns:

lt

public Criteria lt(Object o)
Creates a criterion using the $lt operator

Parameters:
o -
Returns:

lte

public Criteria lte(Object o)
Creates a criterion using the $lte operator

Parameters:
o -
Returns:

gt

public Criteria gt(Object o)
Creates a criterion using the $gt operator

Parameters:
o -
Returns:

gte

public Criteria gte(Object o)
Creates a criterion using the $gte operator

Parameters:
o -
Returns:

in

public Criteria in(Object... o)
Creates a criterion using the $in operator

Parameters:
o - the values to match against
Returns:

in

public Criteria in(Collection<?> c)
Creates a criterion using the $in operator

Parameters:
c - the collection containing the values to match against
Returns:

nin

public Criteria nin(Object... o)
Creates a criterion using the $nin operator

Parameters:
o -
Returns:

nin

public Criteria nin(Collection<?> o)

mod

public Criteria mod(Number value,
                    Number remainder)
Creates a criterion using the $mod operator

Parameters:
value -
remainder -
Returns:

all

public Criteria all(Object... o)
Creates a criterion using the $all operator

Parameters:
o -
Returns:

all

public Criteria all(Collection<?> o)

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(String re)
Creates a criterion using a $regex

Parameters:
re -
Returns:

regex

public Criteria regex(String re,
                      String options)
Creates a criterion using a $regex and $options

Parameters:
re -
options -
Returns:

regex

public Criteria regex(Pattern pattern)
Syntactical sugar for is(Object) making obvious that we create a regex predicate.

Parameters:
pattern -
Returns:

withinSphere

public Criteria withinSphere(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:

within

public Criteria within(Shape shape)

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:

orOperator

public Criteria orOperator(Criteria... criteria)
Creates an 'or' criteria using the $or operator for all of the provided criteria

Parameters:
criteria -

norOperator

public Criteria norOperator(Criteria... criteria)
Creates a 'nor' criteria using the $nor operator for all of the provided criteria

Parameters:
criteria -

andOperator

public Criteria andOperator(Criteria... criteria)
Creates an 'and' criteria using the $and operator for all of the provided criteria

Parameters:
criteria -

getKey

public String getKey()

getCriteriaObject

public DBObject getCriteriaObject()
Specified by:
getCriteriaObject in interface CriteriaDefinition

getSingleCriteriaObject

protected DBObject getSingleCriteriaObject()

Spring Data Document

Copyright © 2012. All Rights Reserved.