MongoCriteriaBuilder (GORM for MongoDB

org.grails.datastore.gorm.mongo.MongoCriteriaBuilder

@java.lang.SuppressWarnings("rawtypes")
public class MongoCriteriaBuilder
extends grails.gorm.CriteriaBuilder

Extends the default CriteriaBuilder implementation with Geolocation methods

Authors:: Graeme Rocher

Since:: 1.0

Inherited fields
Fields inherited from class	Fields
`class grails.gorm.CriteriaBuilder`	`ORDER_DESCENDING, ORDER_ASCENDING, ORDER_DESCENDING, ORDER_ASCENDING`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public org.hibernate.Criteria`	`arguments(java.util.Map arguments)`
	`public org.hibernate.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 org.hibernate.Criteria`	`geoWithin(java.lang.String property, Shape shape)` Geospacial query for the given shape returning records that are found within the given shape
	`public org.hibernate.Criteria`	`near(java.lang.String property, java.util.List<?> value)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.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 org.hibernate.Criteria`	`near(java.lang.String property, java.util.List<?> value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`near(java.lang.String property, Point value)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`near(java.lang.String property, Point value, java.lang.Number maxDistance)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`near(java.lang.String property, Point value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`nearSphere(java.lang.String property, java.util.List<?> value)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.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 org.hibernate.Criteria`	`nearSphere(java.lang.String property, java.util.List<?> value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`nearSphere(java.lang.String property, Point value)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`nearSphere(java.lang.String property, Point value, java.lang.Number maxDistance)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`nearSphere(java.lang.String property, Point value, Distance maxDistance)` Geospacial query for values near the given two dimensional list
	`public org.hibernate.Criteria`	`withinBox(java.lang.String property, java.util.List<?> value)` Geospacial query for values within a given box.
	`public org.hibernate.Criteria`	`withinCircle(java.lang.String property, java.util.List<?> value)` Geospacial query for values within a given circle.
	`public org.hibernate.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 grails.gorm.CriteriaBuilder`	grails.gorm.CriteriaBuilder#select(java.lang.String), grails.gorm.CriteriaBuilder#select(java.lang.String), grails.gorm.CriteriaBuilder#listDistinct(groovy.lang.Closure), grails.gorm.CriteriaBuilder#listDistinct(groovy.lang.Closure), grails.gorm.CriteriaBuilder#scroll(groovy.lang.Closure), grails.gorm.CriteriaBuilder#get(groovy.lang.Closure), grails.gorm.CriteriaBuilder#cache(boolean), grails.gorm.CriteriaBuilder#cache(boolean), grails.gorm.CriteriaBuilder#join(java.lang.String), grails.gorm.CriteriaBuilder#join(java.lang.String), grails.gorm.CriteriaBuilder#join(java.lang.String, jakarta.persistence.criteria.JoinType), grails.gorm.CriteriaBuilder#count(groovy.lang.Closure), grails.gorm.CriteriaBuilder#list(groovy.lang.Closure), grails.gorm.CriteriaBuilder#list(groovy.lang.Closure), grails.gorm.CriteriaBuilder#list(java.util.Map, groovy.lang.Closure), grails.gorm.CriteriaBuilder#list(java.util.Map, groovy.lang.Closure), grails.gorm.CriteriaBuilder#readOnly(boolean), grails.gorm.CriteriaBuilder#readOnly(boolean), grails.gorm.CriteriaBuilder#isNotEmpty(java.lang.String), grails.gorm.CriteriaBuilder#gt(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#projections(groovy.lang.Closure), grails.gorm.CriteriaBuilder#rlike(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#setUniqueResult(boolean), grails.gorm.CriteriaBuilder#ge(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#rowCount(), grails.gorm.CriteriaBuilder#like(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#inList(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#inList(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#inList(java.lang.String, java.util.Collection), grails.gorm.CriteriaBuilder#inList(java.lang.String, [Ljava.lang.Object;), grails.gorm.CriteriaBuilder#isNotNull(java.lang.String), grails.gorm.CriteriaBuilder#ilike(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#eqAll(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#eqAll(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#gtAll(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#gtAll(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#ltAll(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#ltAll(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#geAll(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#geAll(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#leAll(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#leAll(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#eqProperty(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#neProperty(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#gtProperty(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#ltProperty(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#geProperty(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#leProperty(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#sizeEq(java.lang.String, int), grails.gorm.CriteriaBuilder#sizeNe(java.lang.String, int), grails.gorm.CriteriaBuilder#sizeGt(java.lang.String, int), grails.gorm.CriteriaBuilder#sizeLt(java.lang.String, int), grails.gorm.CriteriaBuilder#sizeGe(java.lang.String, int), grails.gorm.CriteriaBuilder#sizeLe(java.lang.String, int), grails.gorm.CriteriaBuilder#countDistinct(java.lang.String), grails.gorm.CriteriaBuilder#notIn(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#notIn(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#allEq(java.util.Map), grails.gorm.CriteriaBuilder#idEquals(java.lang.Object), grails.gorm.CriteriaBuilder#idEq(java.lang.Object), grails.gorm.CriteriaBuilder#gte(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#lte(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#gtSome(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#gtSome(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#geSome(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#geSome(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#ltSome(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#ltSome(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#leSome(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#leSome(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#groupProperty(java.lang.String), grails.gorm.CriteriaBuilder#getTargetClass(), grails.gorm.CriteriaBuilder#min(java.lang.String), grails.gorm.CriteriaBuilder#max(java.lang.String), grails.gorm.CriteriaBuilder#isEmpty(java.lang.String), grails.gorm.CriteriaBuilder#count(), grails.gorm.CriteriaBuilder#count(), grails.gorm.CriteriaBuilder#id(), grails.gorm.CriteriaBuilder#id(), grails.gorm.CriteriaBuilder#in(java.lang.String, org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#in(java.lang.String, groovy.lang.Closure), grails.gorm.CriteriaBuilder#in(java.lang.String, [Ljava.lang.Object;), grails.gorm.CriteriaBuilder#in(java.lang.String, java.util.Collection), grails.gorm.CriteriaBuilder#le(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#getQuery(), grails.gorm.CriteriaBuilder#sum(java.lang.String), grails.gorm.CriteriaBuilder#eq(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#exists(org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#isNull(java.lang.String), grails.gorm.CriteriaBuilder#distinct(java.lang.String), grails.gorm.CriteriaBuilder#distinct(), grails.gorm.CriteriaBuilder#order(org.grails.datastore.mapping.query.Query$Order), grails.gorm.CriteriaBuilder#order(java.lang.String, java.lang.String), grails.gorm.CriteriaBuilder#order(java.lang.String), grails.gorm.CriteriaBuilder#lt(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#build(groovy.lang.Closure), grails.gorm.CriteriaBuilder#or(groovy.lang.Closure), grails.gorm.CriteriaBuilder#between(java.lang.String, java.lang.Object, java.lang.Object), grails.gorm.CriteriaBuilder#and(groovy.lang.Closure), grails.gorm.CriteriaBuilder#not(groovy.lang.Closure), grails.gorm.CriteriaBuilder#notExists(org.grails.datastore.mapping.query.api.QueryableCriteria), grails.gorm.CriteriaBuilder#ne(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#property(java.lang.String), grails.gorm.CriteriaBuilder#avg(java.lang.String), grails.gorm.CriteriaBuilder#invokeMethod(java.lang.String, java.lang.Object), grails.gorm.CriteriaBuilder#getMetaClass(), grails.gorm.CriteriaBuilder#setMetaClass(groovy.lang.MetaClass), grails.gorm.CriteriaBuilder#wait(long, int), grails.gorm.CriteriaBuilder#wait(), grails.gorm.CriteriaBuilder#wait(long), grails.gorm.CriteriaBuilder#equals(java.lang.Object), grails.gorm.CriteriaBuilder#toString(), grails.gorm.CriteriaBuilder#hashCode(), grails.gorm.CriteriaBuilder#getClass(), grails.gorm.CriteriaBuilder#notify(), grails.gorm.CriteriaBuilder#notifyAll(), grails.gorm.CriteriaBuilder#getProperty(java.lang.String), grails.gorm.CriteriaBuilder#setProperty(java.lang.String, java.lang.Object)

- Constructor Detail
  - public MongoCriteriaBuilder(java.lang.Class<?> targetClass, org.hibernate.Session session, org.grails.datastore.mapping.query.Query query)
  - public MongoCriteriaBuilder(java.lang.Class<?> targetClass, org.hibernate.Session session)
- Method Detail
  - public org.hibernate.Criteria arguments(java.util.Map arguments)
  - public org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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 org.hibernate.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, org.hibernate.Session session, org.grails.datastore.mapping.query.Query query)

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

Method Detail

public org.hibernate.Criteria arguments(java.util.Map arguments)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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