CriteriaBuilder (GORM for Mongodb 5.0.13)

grails.gorm.CriteriaBuilder

All Implemented Interfaces and Traits:

BuildableCriteria, ProjectionList
```
@java.lang.SuppressWarnings("rawtypes")
public class CriteriaBuilder
extends groovy.lang.GroovyObjectSupport
```
Criteria builder implementation that operates against DataStore abstraction.
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`ORDER_ASCENDING`
`static java.lang.String`	`ORDER_DESCENDING`
`protected java.util.List<Query.Order>`	`orderEntries`
`protected PersistentEntity`	`persistentEntity`
`protected ProjectionList`	`projectionList`
`protected Query`	`query`
`protected groovy.lang.MetaObjectProtocol`	`queryMetaClass`
`protected boolean`	`readOnly`
`protected Session`	`session`
`protected java.lang.Class`	`targetClass`

Constructor Summary

Constructors
Constructor and description
`CriteriaBuilder (java.lang.Class targetClass, Session session)`
`CriteriaBuilder (java.lang.Class targetClass, Session session, Query query)`

Methods Summary

Methods
Type	Name and description
`protected Criterion`	`addToCriteria(Criterion c)`
`Criteria`	`allEq(java.util.Map<java.lang.String, java.lang.Object> propertyValues)` Apply an "equals" constraint to each property in the key set of a `Map`
`Criteria`	`and(groovy.lang.Closure callable)`
`ProjectionList`	`avg(java.lang.String name)` Computes the average value of a property
`Criteria`	`between(java.lang.String propertyName, java.lang.Object start, java.lang.Object finish)` Restricts the results by the given property value range (inclusive)
`void`	`build(groovy.lang.Closure criteria)`
`BuildableCriteria`	`cache(boolean cache)`
`ProjectionList`	`count()` Count the number of records returned
`java.lang.Number`	`count(groovy.lang.Closure callable)` Defines and executes a count query in a single call.
`ProjectionList`	`countDistinct(java.lang.String property)` Projection that signifies to count distinct results
`ProjectionList`	`distinct()` Projection that signifies to return only distinct results
`ProjectionList`	`distinct(java.lang.String property)` Projection that signifies to return only distinct results
`Criteria`	`eq(java.lang.String propertyName, java.lang.Object propertyValue)` Creates an "equals" Criterion based on the specified property name and value.
`Criteria`	`eqAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)` Creates a subquery criterion that ensures the given property is equal to all the given returned values
`Criteria`	`eqAll(java.lang.String propertyName, QueryableCriteria propertyValue)` Creates a subquery criterion that ensures the given property is equal to all the given returned values
`Criteria`	`eqProperty(java.lang.String propertyName, java.lang.String otherPropertyName)` Constraints a property to be equal to a specified other property
`Criteria`	`exists(QueryableCriteria<?> subquery)`
`Criteria`	`ge(java.lang.String property, java.lang.Object value)` Used to restrict a value to be greater than or equal to the given value
`Criteria`	`geAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)` Creates a subquery criterion that ensures the given property is greater than all the given returned values
`Criteria`	`geAll(java.lang.String propertyName, QueryableCriteria propertyValue)` Creates a subquery criterion that ensures the given property is greater than all the given returned values
`Criteria`	`geProperty(java.lang.String propertyName, java.lang.String otherPropertyName)` Constraints a property to be greater than or equal to a specified other property
`Criteria`	`geSome(java.lang.String propertyName, QueryableCriteria propertyValue)`
`Criteria`	`geSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)`
`java.lang.Object`	`get(groovy.lang.Closure callable)` Defines and executes a get query (a single result) in a single call.
`Query`	`getQuery()`
`java.lang.Class`	`getTargetClass()`
`ProjectionList`	`groupProperty(java.lang.String property)` Defines a group by projection for datastores that support it
`Criteria`	`gt(java.lang.String property, java.lang.Object value)` Used to restrict a value to be greater than or equal to the given value
`Criteria`	`gtAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)` Creates a subquery criterion that ensures the given property is greater than all the given returned values
`Criteria`	`gtAll(java.lang.String propertyName, QueryableCriteria propertyValue)` Creates a subquery criterion that ensures the given property is greater than all the given returned values
`Criteria`	`gtProperty(java.lang.String propertyName, java.lang.String otherPropertyName)` Constraints a property to be greater than a specified other property
`Criteria`	`gtSome(java.lang.String propertyName, QueryableCriteria propertyValue)`
`Criteria`	`gtSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)`
`Criteria`	`gte(java.lang.String property, java.lang.Object value)` Used to restrict a value to be greater than or equal to the given value
`ProjectionList`	`id()`
`Criteria`	`idEq(java.lang.Object propertyValue)` Creates an "equals" Criterion based on the specified property name and value.
`Criteria`	`idEquals(java.lang.Object value)`
`Criteria`	`ilike(java.lang.String propertyName, java.lang.Object propertyValue)` Creates an ilike Criterion based on the specified property name and value.
`Criteria`	`in(java.lang.String propertyName, QueryableCriteria<?> subquery)`
`Criteria`	`in(java.lang.String propertyName, groovy.lang.Closure<?> subquery)`
`Criteria`	`in(java.lang.String propertyName, java.util.Collection values)` Creates an "in" Criterion based on the specified property name and list of values.
`Criteria`	`in(java.lang.String propertyName, java.lang.Object[] values)` Creates an "in" Criterion based on the specified property name and list of values.
`Criteria`	`inList(java.lang.String propertyName, QueryableCriteria<?> subquery)`
`Criteria`	`inList(java.lang.String propertyName, groovy.lang.Closure<?> subquery)`
`Criteria`	`inList(java.lang.String propertyName, java.util.Collection values)` Creates an "in" Criterion based on the specified property name and list of values.
`Criteria`	`inList(java.lang.String propertyName, java.lang.Object[] values)` Creates an "in" Criterion based on the specified property name and list of values.
`java.lang.Object`	`invokeMethod(java.lang.String name, java.lang.Object obj)`
`Criteria`	`isEmpty(java.lang.String propertyName)`
`Criteria`	`isNotEmpty(java.lang.String propertyName)`
`Criteria`	`isNotNull(java.lang.String propertyName)`
`Criteria`	`isNull(java.lang.String propertyName)`
`BuildableCriteria`	`join(java.lang.String property)`
`Criteria`	`le(java.lang.String property, java.lang.Object value)` Used to restrict a value to be less than or equal to the given value
`Criteria`	`leAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)` Creates a subquery criterion that ensures the given property is less than all the given returned values
`Criteria`	`leAll(java.lang.String propertyName, QueryableCriteria propertyValue)` Creates a subquery criterion that ensures the given property is less than all the given returned values
`Criteria`	`leProperty(java.lang.String propertyName, java.lang.String otherPropertyName)` Constraints a property to be less than or equal to a specified other property
`Criteria`	`leSome(java.lang.String propertyName, QueryableCriteria propertyValue)`
`Criteria`	`leSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)`
`Criteria`	`like(java.lang.String propertyName, java.lang.Object propertyValue)` Creates an like Criterion based on the specified property name and value.
`java.util.List`	`list(groovy.lang.Closure callable)` Defines and executes a list query in a single call.
`java.util.List`	`list(java.util.Map paginateParams, groovy.lang.Closure callable)`
`java.util.List`	`listDistinct(groovy.lang.Closure callable)` Defines and executes a list distinct query in a single call.
`Criteria`	`lt(java.lang.String property, java.lang.Object value)` Used to restrict a value to be less than or equal to the given value
`Criteria`	`ltAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)` Creates a subquery criterion that ensures the given property is less than all the given returned values
`Criteria`	`ltAll(java.lang.String propertyName, QueryableCriteria propertyValue)` Creates a subquery criterion that ensures the given property is less than all the given returned values
`Criteria`	`ltProperty(java.lang.String propertyName, java.lang.String otherPropertyName)` Constraints a property to be less than a specified other property
`Criteria`	`ltSome(java.lang.String propertyName, QueryableCriteria propertyValue)`
`Criteria`	`ltSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)`
`Criteria`	`lte(java.lang.String property, java.lang.Object value)` Used to restrict a value to be less than or equal to the given value
`ProjectionList`	`max(java.lang.String name)` Computes the max value of a property
`ProjectionList`	`min(java.lang.String name)` Computes the min value of a property
`Criteria`	`ne(java.lang.String propertyName, java.lang.Object propertyValue)` Creates a "not equals" Criterion based on the specified property name and value.
`Criteria`	`neProperty(java.lang.String propertyName, java.lang.String otherPropertyName)` Constraints a property to be not equal to a specified other property
`Criteria`	`not(groovy.lang.Closure callable)`
`Criteria`	`notExists(QueryableCriteria<?> subquery)`
`Criteria`	`notIn(java.lang.String propertyName, QueryableCriteria<?> subquery)`
`Criteria`	`notIn(java.lang.String propertyName, groovy.lang.Closure<?> subquery)`
`Criteria`	`or(groovy.lang.Closure callable)`
`Criteria`	`order(java.lang.String propertyName)` Orders by the specified property name (defaults to ascending)
`Criteria`	`order(Order o)` Orders by the specified property name (defaults to ascending)
`Criteria`	`order(java.lang.String propertyName, java.lang.String direction)` Orders by the specified property name and direction
`ProjectionList`	`projections(groovy.lang.Closure callable)` Defines projections
`ProjectionList`	`property(java.lang.String name)` A projection that obtains the value of a property of an entity
`BuildableCriteria`	`readOnly(boolean readOnly)`
`Criteria`	`rlike(java.lang.String propertyName, java.lang.Object propertyValue)` Creates an rlike Criterion based on the specified property name and value.
`ProjectionList`	`rowCount()` Count the number of records returned
`java.lang.Object`	`scroll(groovy.lang.Closure c)`
`BuildableCriteria`	`select(java.lang.String property)`
`void`	`setUniqueResult(boolean uniqueResult)`
`Criteria`	`sizeEq(java.lang.String propertyName, int size)`
`Criteria`	`sizeGe(java.lang.String propertyName, int size)`
`Criteria`	`sizeGt(java.lang.String propertyName, int size)`
`Criteria`	`sizeLe(java.lang.String propertyName, int size)`
`Criteria`	`sizeLt(java.lang.String propertyName, int size)`
`Criteria`	`sizeNe(java.lang.String propertyName, int size)`
`ProjectionList`	`sum(java.lang.String name)` Computes the sum of a property
`protected void`	`validatePropertyName(java.lang.String propertyName, java.lang.String methodName)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.lang.GroovyObjectSupport`	groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String ORDER_ASCENDING
  - public static final java.lang.String ORDER_DESCENDING
  - protected java.util.List<Query.Order> orderEntries
  - protected PersistentEntity persistentEntity
  - protected ProjectionList projectionList
  - protected Query query
  - protected groovy.lang.MetaObjectProtocol queryMetaClass
  - protected boolean readOnly
  - protected Session session
  - protected java.lang.Class targetClass
- Constructor Detail
  - public CriteriaBuilder(java.lang.Class targetClass, Session session)
  - public CriteriaBuilder(java.lang.Class targetClass, Session session, Query query)
- Method Detail
  - protected Criterion addToCriteria(Criterion c)
  - @java.lang.Override public Criteria allEq(java.util.Map<java.lang.String, java.lang.Object> propertyValues)
    
    Apply an "equals" constraint to each property in the key set of a Map
    Returns:
    Criterion
    Parameters:
    propertyValues - a map from property names to values
    See Also:
    org.grails.datastore.mapping.query.Query.Conjunction
  - public Criteria and(groovy.lang.Closure callable)
  - public ProjectionList avg(java.lang.String name)
    
    Computes the average value of a property
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property
  - public Criteria between(java.lang.String propertyName, java.lang.Object start, java.lang.Object finish)
    
    Restricts the results by the given property value range (inclusive)
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    start - The start of the range
    finish - The end of the range
  - public void build(groovy.lang.Closure criteria)
  - @java.lang.Override public BuildableCriteria cache(boolean cache)
  - public ProjectionList count()
    
    Count the number of records returned
    Returns:
    The project list
  - public java.lang.Number count(groovy.lang.Closure callable)
    
    Defines and executes a count query in a single call. Example: Foo.createCriteria.count { }
    Returns:
    The result count
    Parameters:
    callable - The closure to execute
  - public ProjectionList countDistinct(java.lang.String property)
    
    Projection that signifies to count distinct results
    Returns:
    The projection list
    Parameters:
    property - The name of the property
  - public ProjectionList distinct()
    
    Projection that signifies to return only distinct results
    Returns:
    The projection list
  - public ProjectionList distinct(java.lang.String property)
    
    Projection that signifies to return only distinct results
    Returns:
    The projection list
    Parameters:
    property - The name of the property
  - public Criteria eq(java.lang.String propertyName, java.lang.Object propertyValue)
    
    Creates an "equals" Criterion based on the specified property name and value.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria eqAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)
    
    Creates a subquery criterion that ensures the given property is equal to all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria eqAll(java.lang.String propertyName, QueryableCriteria propertyValue)
    
    Creates a subquery criterion that ensures the given property is equal to all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria eqProperty(java.lang.String propertyName, java.lang.String otherPropertyName)
    
    Constraints a property to be equal to a specified other property
    Returns:
    This criteria
    Parameters:
    propertyName - The property
    otherPropertyName - The other property
  - @java.lang.Override public Criteria exists(QueryableCriteria<?> subquery)
  - public Criteria ge(java.lang.String property, java.lang.Object value)
    
    Used to restrict a value to be greater than or equal to the given value
    Returns:
    The Criterion instance
    Parameters:
    property - The property
    value - The value
  - public Criteria geAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)
    
    Creates a subquery criterion that ensures the given property is greater than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria geAll(java.lang.String propertyName, QueryableCriteria propertyValue)
    
    Creates a subquery criterion that ensures the given property is greater than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria geProperty(java.lang.String propertyName, java.lang.String otherPropertyName)
    
    Constraints a property to be greater than or equal to a specified other property
    Returns:
    This criteria
    Parameters:
    propertyName - The property
    otherPropertyName - The other property
  - @java.lang.Override public Criteria geSome(java.lang.String propertyName, QueryableCriteria propertyValue)
  - @java.lang.Override public Criteria geSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)
  - public java.lang.Object get(groovy.lang.Closure callable)
    
    Defines and executes a get query (a single result) in a single call. Example: Foo.createCriteria.get { }
    Returns:
    A single result
    Parameters:
    callable - The closure to execute
  - public Query getQuery()
  - @java.lang.Override public java.lang.Class getTargetClass()
  - @java.lang.Override public ProjectionList groupProperty(java.lang.String property)
    
    Defines a group by projection for datastores that support it
    Returns:
    The projection list
    Parameters:
    property - The property name
  - public Criteria gt(java.lang.String property, java.lang.Object value)
    
    Used to restrict a value to be greater than or equal to the given value
    Returns:
    The Criterion instance
    Parameters:
    property - The property
    value - The value
  - public Criteria gtAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)
    
    Creates a subquery criterion that ensures the given property is greater than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria gtAll(java.lang.String propertyName, QueryableCriteria propertyValue)
    
    Creates a subquery criterion that ensures the given property is greater than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria gtProperty(java.lang.String propertyName, java.lang.String otherPropertyName)
    
    Constraints a property to be greater than a specified other property
    Returns:
    This criteria
    Parameters:
    propertyName - The property
    otherPropertyName - The other property
  - @java.lang.Override public Criteria gtSome(java.lang.String propertyName, QueryableCriteria propertyValue)
  - @java.lang.Override public Criteria gtSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)
  - public Criteria gte(java.lang.String property, java.lang.Object value)
    
    Used to restrict a value to be greater than or equal to the given value
    Returns:
    The Criterion instance
    Parameters:
    property - The property
    value - The value
  - public ProjectionList id()
  - public Criteria idEq(java.lang.Object propertyValue)
    
    Creates an "equals" Criterion based on the specified property name and value.
    Returns:
    A Criterion instance
    Parameters:
    propertyValue - The property value
  - public Criteria idEquals(java.lang.Object value)
  - public Criteria ilike(java.lang.String propertyName, java.lang.Object propertyValue)
    
    Creates an ilike Criterion based on the specified property name and value. Unlike a like condition, ilike is case insensitive
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - @java.lang.Override public Criteria in(java.lang.String propertyName, QueryableCriteria<?> subquery)
  - @java.lang.Override public Criteria in(java.lang.String propertyName, groovy.lang.Closure<?> subquery)
  - public Criteria in(java.lang.String propertyName, java.util.Collection values)
    
    Creates an "in" Criterion based on the specified property name and list of values.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    values - The values
  - public Criteria in(java.lang.String propertyName, java.lang.Object[] values)
    
    Creates an "in" Criterion based on the specified property name and list of values.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    values - The values
  - @java.lang.Override public Criteria inList(java.lang.String propertyName, QueryableCriteria<?> subquery)
  - @java.lang.Override public Criteria inList(java.lang.String propertyName, groovy.lang.Closure<?> subquery)
  - public Criteria inList(java.lang.String propertyName, java.util.Collection values)
    
    Creates an "in" Criterion based on the specified property name and list of values.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    values - The values
  - public Criteria inList(java.lang.String propertyName, java.lang.Object[] values)
    
    Creates an "in" Criterion based on the specified property name and list of values.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    values - The values
  - @java.lang.Override public java.lang.Object invokeMethod(java.lang.String name, java.lang.Object obj)
  - public Criteria isEmpty(java.lang.String propertyName)
  - public Criteria isNotEmpty(java.lang.String propertyName)
  - public Criteria isNotNull(java.lang.String propertyName)
  - public Criteria isNull(java.lang.String propertyName)
  - @java.lang.Override public BuildableCriteria join(java.lang.String property)
  - public Criteria le(java.lang.String property, java.lang.Object value)
    
    Used to restrict a value to be less than or equal to the given value
    Returns:
    The Criterion instance
    Parameters:
    property - The property
    value - The value
  - public Criteria leAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)
    
    Creates a subquery criterion that ensures the given property is less than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria leAll(java.lang.String propertyName, QueryableCriteria propertyValue)
    
    Creates a subquery criterion that ensures the given property is less than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria leProperty(java.lang.String propertyName, java.lang.String otherPropertyName)
    
    Constraints a property to be less than or equal to a specified other property
    Returns:
    This criteria
    Parameters:
    propertyName - The property
    otherPropertyName - The other property
  - @java.lang.Override public Criteria leSome(java.lang.String propertyName, QueryableCriteria propertyValue)
  - @java.lang.Override public Criteria leSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)
  - public Criteria like(java.lang.String propertyName, java.lang.Object propertyValue)
    
    Creates an like Criterion based on the specified property name and value.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public java.util.List list(groovy.lang.Closure callable)
    
    Defines and executes a list query in a single call. Example: Foo.createCriteria.list { }
    Returns:
    The result list
    Parameters:
    callable - The closure to execute
  - public java.util.List list(java.util.Map paginateParams, groovy.lang.Closure callable)
  - public java.util.List listDistinct(groovy.lang.Closure callable)
    
    Defines and executes a list distinct query in a single call. Example: Foo.createCriteria.listDistinct { }
    Returns:
    The result list
    Parameters:
    callable - The closure to execute
  - public Criteria lt(java.lang.String property, java.lang.Object value)
    
    Used to restrict a value to be less than or equal to the given value
    Returns:
    The Criterion instance
    Parameters:
    property - The property
    value - The value
  - public Criteria ltAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)
    
    Creates a subquery criterion that ensures the given property is less than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria ltAll(java.lang.String propertyName, QueryableCriteria propertyValue)
    
    Creates a subquery criterion that ensures the given property is less than all the given returned values
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria ltProperty(java.lang.String propertyName, java.lang.String otherPropertyName)
    
    Constraints a property to be less than a specified other property
    Returns:
    This criteria
    Parameters:
    propertyName - The property
    otherPropertyName - The other property
  - @java.lang.Override public Criteria ltSome(java.lang.String propertyName, QueryableCriteria propertyValue)
  - @java.lang.Override public Criteria ltSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)
  - public Criteria lte(java.lang.String property, java.lang.Object value)
    
    Used to restrict a value to be less than or equal to the given value
    Returns:
    The Criterion instance
    Parameters:
    property - The property
    value - The value
  - public ProjectionList max(java.lang.String name)
    
    Computes the max value of a property
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property
  - public ProjectionList min(java.lang.String name)
    
    Computes the min value of a property
    Returns:
    The projection list
    Parameters:
    name - The name of the property
  - public Criteria ne(java.lang.String propertyName, java.lang.Object propertyValue)
    
    Creates a "not equals" Criterion based on the specified property name and value.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public Criteria neProperty(java.lang.String propertyName, java.lang.String otherPropertyName)
    
    Constraints a property to be not equal to a specified other property
    Returns:
    This criteria
    Parameters:
    propertyName - The property
    otherPropertyName - The other property
  - public Criteria not(groovy.lang.Closure callable)
  - @java.lang.Override public Criteria notExists(QueryableCriteria<?> subquery)
  - @java.lang.Override public Criteria notIn(java.lang.String propertyName, QueryableCriteria<?> subquery)
  - @java.lang.Override public Criteria notIn(java.lang.String propertyName, groovy.lang.Closure<?> subquery)
  - public Criteria or(groovy.lang.Closure callable)
  - public Criteria order(java.lang.String propertyName)
    
    Orders by the specified property name (defaults to ascending)
    Returns:
    A Order instance
    Parameters:
    propertyName - The property name to order by
  - @java.lang.Override public Criteria order(Order o)
    
    Orders by the specified property name (defaults to ascending)
    Returns:
    This criteria
    Parameters:
    o - The order object
  - public Criteria order(java.lang.String propertyName, java.lang.String direction)
    
    Orders by the specified property name and direction
    Returns:
    A Order instance
    Parameters:
    propertyName - The property name to order by
    direction - Either "asc" for ascending or "desc" for descending
  - public ProjectionList projections(groovy.lang.Closure callable)
    
    Defines projections
    Returns:
    The projections list
    Parameters:
    callable - The closure defining the projections
  - public ProjectionList property(java.lang.String name)
    
    A projection that obtains the value of a property of an entity
    Returns:
    The projection list
    Parameters:
    name - The name of the property
  - @java.lang.Override public BuildableCriteria readOnly(boolean readOnly)
  - public Criteria rlike(java.lang.String propertyName, java.lang.Object propertyValue)
    
    Creates an rlike Criterion based on the specified property name and value.
    Returns:
    A Criterion instance
    Parameters:
    propertyName - The property name
    propertyValue - The property value
  - public ProjectionList rowCount()
    
    Count the number of records returned
    Returns:
    The project list
  - @java.lang.Override public java.lang.Object scroll(@groovy.lang.DelegatesTo(Criteria.class) groovy.lang.Closure c)
  - @java.lang.Override public BuildableCriteria select(java.lang.String property)
  - public void setUniqueResult(boolean uniqueResult)
  - public Criteria sizeEq(java.lang.String propertyName, int size)
  - public Criteria sizeGe(java.lang.String propertyName, int size)
  - public Criteria sizeGt(java.lang.String propertyName, int size)
  - public Criteria sizeLe(java.lang.String propertyName, int size)
  - public Criteria sizeLt(java.lang.String propertyName, int size)
  - public Criteria sizeNe(java.lang.String propertyName, int size)
  - public ProjectionList sum(java.lang.String name)
    
    Computes the sum of a property
    Returns:
    The projection list
    Parameters:
    name - The name of the property
  - protected void validatePropertyName(java.lang.String propertyName, java.lang.String methodName)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class CriteriaBuilder

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String ORDER_ASCENDING

public static final java.lang.String ORDER_DESCENDING

protected java.util.List<Query.Order> orderEntries

protected PersistentEntity persistentEntity

protected ProjectionList projectionList

protected Query query

protected groovy.lang.MetaObjectProtocol queryMetaClass

protected boolean readOnly

protected Session session

protected java.lang.Class targetClass

Constructor Detail

public CriteriaBuilder(java.lang.Class targetClass, Session session)

public CriteriaBuilder(java.lang.Class targetClass, Session session, Query query)

Method Detail

protected Criterion addToCriteria(Criterion c)

@java.lang.Override public Criteria allEq(java.util.Map<java.lang.String, java.lang.Object> propertyValues)

public Criteria and(groovy.lang.Closure callable)

public ProjectionList avg(java.lang.String name)

public Criteria between(java.lang.String propertyName, java.lang.Object start, java.lang.Object finish)

public void build(groovy.lang.Closure criteria)

@java.lang.Override public BuildableCriteria cache(boolean cache)

public ProjectionList count()

public java.lang.Number count(groovy.lang.Closure callable)

public ProjectionList countDistinct(java.lang.String property)

public ProjectionList distinct()

public ProjectionList distinct(java.lang.String property)

public Criteria eq(java.lang.String propertyName, java.lang.Object propertyValue)

public Criteria eqAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)

public Criteria eqAll(java.lang.String propertyName, QueryableCriteria propertyValue)

public Criteria eqProperty(java.lang.String propertyName, java.lang.String otherPropertyName)

@java.lang.Override public Criteria exists(QueryableCriteria<?> subquery)

public Criteria ge(java.lang.String property, java.lang.Object value)

public Criteria geAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)

public Criteria geAll(java.lang.String propertyName, QueryableCriteria propertyValue)

public Criteria geProperty(java.lang.String propertyName, java.lang.String otherPropertyName)

@java.lang.Override public Criteria geSome(java.lang.String propertyName, QueryableCriteria propertyValue)

@java.lang.Override public Criteria geSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)

public java.lang.Object get(groovy.lang.Closure callable)

public Query getQuery()

@java.lang.Override public java.lang.Class getTargetClass()

@java.lang.Override public ProjectionList groupProperty(java.lang.String property)

public Criteria gt(java.lang.String property, java.lang.Object value)

public Criteria gtAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)

public Criteria gtAll(java.lang.String propertyName, QueryableCriteria propertyValue)

public Criteria gtProperty(java.lang.String propertyName, java.lang.String otherPropertyName)

@java.lang.Override public Criteria gtSome(java.lang.String propertyName, QueryableCriteria propertyValue)

@java.lang.Override public Criteria gtSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)

public Criteria gte(java.lang.String property, java.lang.Object value)

public ProjectionList id()

public Criteria idEq(java.lang.Object propertyValue)

public Criteria idEquals(java.lang.Object value)

public Criteria ilike(java.lang.String propertyName, java.lang.Object propertyValue)

@java.lang.Override public Criteria in(java.lang.String propertyName, QueryableCriteria<?> subquery)

@java.lang.Override public Criteria in(java.lang.String propertyName, groovy.lang.Closure<?> subquery)

public Criteria in(java.lang.String propertyName, java.util.Collection values)

public Criteria in(java.lang.String propertyName, java.lang.Object[] values)

@java.lang.Override public Criteria inList(java.lang.String propertyName, QueryableCriteria<?> subquery)

@java.lang.Override public Criteria inList(java.lang.String propertyName, groovy.lang.Closure<?> subquery)

public Criteria inList(java.lang.String propertyName, java.util.Collection values)

public Criteria inList(java.lang.String propertyName, java.lang.Object[] values)

@java.lang.Override public java.lang.Object invokeMethod(java.lang.String name, java.lang.Object obj)

public Criteria isEmpty(java.lang.String propertyName)

public Criteria isNotEmpty(java.lang.String propertyName)

public Criteria isNotNull(java.lang.String propertyName)

public Criteria isNull(java.lang.String propertyName)

@java.lang.Override public BuildableCriteria join(java.lang.String property)

public Criteria le(java.lang.String property, java.lang.Object value)

public Criteria leAll(java.lang.String propertyName, groovy.lang.Closure propertyValue)

public Criteria leAll(java.lang.String propertyName, QueryableCriteria propertyValue)

public Criteria leProperty(java.lang.String propertyName, java.lang.String otherPropertyName)

@java.lang.Override public Criteria leSome(java.lang.String propertyName, QueryableCriteria propertyValue)

@java.lang.Override public Criteria leSome(java.lang.String propertyName, groovy.lang.Closure<?> propertyValue)

public Criteria like(java.lang.String propertyName, java.lang.Object propertyValue)

public java.util.List list(groovy.lang.Closure callable)