MongoCriteriaBuilder (Grace Data MongoDB

org.grails.datastore.gorm.mongo.MongoCriteriaBuilder

```
@SuppressWarnings("rawtypes")
public class MongoCriteriaBuilder
extends CriteriaBuilder
```
Extends the default CriteriaBuilder implementation with Geolocation methods
Authors:
Graeme Rocher
Since:
1.0

Inherited fields
Fields inherited from class	Fields
`class CriteriaBuilder`	`ORDER_DESCENDING, ORDER_ASCENDING, ORDER_DESCENDING, ORDER_ASCENDING`

Constructor Summary

Constructors
Constructor and description
`MongoCriteriaBuilder(Class<?> targetClass, Session session, Query query)`
`MongoCriteriaBuilder(Class<?> targetClass, Session session)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public Criteria`	`arguments(Map arguments)`
	`public Criteria`	`geoIntersects(String property, GeoJSON shape)` Geospacial query for the given shape returning records that are found to intersect the given shape
	`public Criteria`	`geoWithin(String property, Shape shape)` Geospacial query for the given shape returning records that are found within the given shape
	`public Criteria`	`near(String property, List<?> value)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`near(String property, List<?> value, Number maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`near(String property, List<?> value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`near(String property, Point value)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`near(String property, Point value, Number maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`near(String property, Point value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`nearSphere(String property, List<?> value)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`nearSphere(String property, List<?> value, Number maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`nearSphere(String property, List<?> value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`nearSphere(String property, Point value)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`nearSphere(String property, Point value, Number maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`nearSphere(String property, Point value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public Criteria`	`withinBox(String property, List<?> value)` Geospacial query for values within a given box.
	`public Criteria`	`withinCircle(String property, List<?> value)` Geospacial query for values within a given circle.
	`public Criteria`	`withinPolygon(String property, List<?> value)` Geospacial query for values within a given polygon.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class CriteriaBuilder`	allEq, and, avg, between, build, cache, cache, count, count, count, countDistinct, distinct, distinct, eq, eqAll, eqAll, eqProperty, equals, exists, ge, geAll, geAll, geProperty, geSome, geSome, get, getClass, getMetaClass, getProperty, getQuery, getTargetClass, groupProperty, gt, gtAll, gtAll, gtProperty, gtSome, gtSome, gte, hashCode, id, id, idEq, idEquals, ilike, in, in, in, in, inList, inList, inList, inList, invokeMethod, isEmpty, isNotEmpty, isNotNull, isNull, join, join, join, le, leAll, leAll, leProperty, leSome, leSome, like, list, list, list, list, listDistinct, listDistinct, lt, ltAll, ltAll, ltProperty, ltSome, ltSome, lte, max, min, ne, neProperty, not, notExists, notIn, notIn, notify, notifyAll, or, order, order, order, projections, property, readOnly, readOnly, rlike, rowCount, scroll, select, select, setMetaClass, setProperty, setUniqueResult, sizeEq, sizeGe, sizeGt, sizeLe, sizeLt, sizeNe, sum, toString, wait, wait, wait

- Constructor Detail
  - public MongoCriteriaBuilder(Class<?> targetClass, Session session, Query query)
  - public MongoCriteriaBuilder(Class<?> targetClass, Session session)
- Method Detail
  - public Criteria arguments(Map arguments)
  - public Criteria geoIntersects(String property, GeoJSON shape)
    
    Geospacial query for the given shape returning records that are found to intersect the given shape
    Parameters:
    property - The property
    shape - The shape
    Returns:
    The criteria insstance
  - public Criteria geoWithin(String property, Shape shape)
    
    Geospacial query for the given shape returning records that are found within the given shape
    Parameters:
    property - The property
    shape - The shape
    Returns:
    The criteria insstance
  - public Criteria near(String property, List<?> value)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria near(String property, List<?> value, Number maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria near(String property, List<?> value, Distance maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria near(String property, Point value)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria near(String property, Point value, Number maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria near(String property, Point value, Distance maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria nearSphere(String property, List<?> value)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria nearSphere(String property, List<?> value, Number maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria nearSphere(String property, List<?> value, Distance maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria nearSphere(String property, Point value)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria nearSphere(String property, Point value, Number maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria nearSphere(String property, Point value, Distance maxDistance)
    
    Geospacial query for values near the given two dimensional list
    Parameters:
    property - The property
    value - A two dimensional list of values
    Returns:
    this Criterion
  - public Criteria withinBox(String property, List<?> value)
    
    Geospacial query for values within a given box. A box is defined as a multi-dimensional list in the form
    [[40.73083, -73.99756], [40.741404, -73.988135]]
    Parameters:
    property - The property
    value - A multi-dimensional list of values
    Returns:
    this Criterion
  - public Criteria withinCircle(String property, List<?> value)
    
    Geospacial query for values within a given circle. A circle is defined as a multi-dimensial list containing the position of the center and the radius:
    [[50, 50], 10]
    Parameters:
    property - The property
    value - A multi-dimensional list of values
    Returns:
    The criteria insstance
  - public Criteria withinPolygon(String property, List<?> value)
    
    Geospacial query for values within a given polygon. A polygon is defined as a multi-dimensional list in the form
    [[0, 0], [3, 6], [6, 0]]
    Parameters:
    property - The property
    value - A multi-dimensional list of values
    Returns:
    this Criterion

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class MongoCriteriaBuilder

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public MongoCriteriaBuilder(Class<?> targetClass, Session session, Query query)

public MongoCriteriaBuilder(Class<?> targetClass, Session session)

Method Detail

public Criteria arguments(Map arguments)

public Criteria geoIntersects(String property, GeoJSON shape)

public Criteria geoWithin(String property, Shape shape)

public Criteria near(String property, List<?> value)

public Criteria near(String property, List<?> value, Number maxDistance)

public Criteria near(String property, List<?> value, Distance maxDistance)

public Criteria near(String property, Point value)

public Criteria near(String property, Point value, Number maxDistance)

public Criteria near(String property, Point value, Distance maxDistance)

public Criteria nearSphere(String property, List<?> value)

public Criteria nearSphere(String property, List<?> value, Number maxDistance)

public Criteria nearSphere(String property, List<?> value, Distance maxDistance)

public Criteria nearSphere(String property, Point value)

public Criteria nearSphere(String property, Point value, Number maxDistance)

public Criteria nearSphere(String property, Point value, Distance maxDistance)

public Criteria withinBox(String property, List<?> value)

public Criteria withinCircle(String property, List<?> value)

public Criteria withinPolygon(String property, List<?> value)