MongoCriteriaBuilder (GORM for MongoDB

org.grails.datastore.gorm.mongo.MongoCriteriaBuilder

```
@java.lang.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_ASCENDING, ORDER_DESCENDING, session`
`class AbstractCriteriaBuilder`	`ORDER_ASCENDING, ORDER_DESCENDING, ROOT_CALL, ROOT_DO_CALL, SCROLL_CALL, logicalExpressionStack, orderEntries, paginationEnabledList, persistentEntity, projectionList, query, queryCreator, queryMetaClass, readOnly, targetClass, uniqueResult`

Constructor Summary

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

Methods Summary

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

Inherited Methods Summary

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

- Constructor Detail
  - public MongoCriteriaBuilder(java.lang.Class<?> targetClass, Session session, Query query)
  - public MongoCriteriaBuilder(java.lang.Class<?> targetClass, Session session)
- Method Detail
  - public Criteria arguments(java.util.Map arguments)
  - public Criteria geoIntersects(java.lang.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(java.lang.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(java.lang.String property, java.util.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(java.lang.String property, java.util.List<?> value, java.lang.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(java.lang.String property, java.util.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(java.lang.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(java.lang.String property, Point value, java.lang.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(java.lang.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(java.lang.String property, java.util.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(java.lang.String property, java.util.List<?> value, java.lang.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(java.lang.String property, java.util.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(java.lang.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(java.lang.String property, Point value, java.lang.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(java.lang.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(java.lang.String property, java.util.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(java.lang.String property, java.util.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(java.lang.String property, java.util.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(java.lang.Class<?> targetClass, Session session, Query query)

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

Method Detail

public Criteria arguments(java.util.Map arguments)

public Criteria geoIntersects(java.lang.String property, GeoJSON shape)

public Criteria geoWithin(java.lang.String property, Shape shape)

public Criteria near(java.lang.String property, java.util.List<?> value)

public Criteria near(java.lang.String property, java.util.List<?> value, java.lang.Number maxDistance)

public Criteria near(java.lang.String property, java.util.List<?> value, Distance maxDistance)

public Criteria near(java.lang.String property, Point value)

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

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

public Criteria nearSphere(java.lang.String property, java.util.List<?> value)

public Criteria nearSphere(java.lang.String property, java.util.List<?> value, java.lang.Number maxDistance)

public Criteria nearSphere(java.lang.String property, java.util.List<?> value, Distance maxDistance)

public Criteria nearSphere(java.lang.String property, Point value)

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

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

public Criteria withinBox(java.lang.String property, java.util.List<?> value)

public Criteria withinCircle(java.lang.String property, java.util.List<?> value)

public Criteria withinPolygon(java.lang.String property, java.util.List<?> value)