Projections (GORM for Hibernate 5

org.grails.datastore.mapping.query.Projections

Projections used to customize the results of a query
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`static CountProjection`	`COUNT_PROJECTION`
`static IdProjection`	`ID_PROJECTION`

Methods Summary

Methods
Type	Name and description
`static AvgProjection`	`avg(java.lang.String name)` Computes the average value of a property
`static CountProjection`	`count()` Projection that returns the number of records from the query instead of the results themselves
`static CountDistinctProjection`	`countDistinct(java.lang.String property)` Projection that signifies to return only distinct results
`static DistinctProjection`	`distinct()` Projection that signifies to return only distinct results
`static DistinctPropertyProjection`	`distinct(java.lang.String property)` Projection that signifies to return only distinct results
`static GroupPropertyProjection`	`groupProperty(java.lang.String property)` Defines a group by projection for datastores that support it
`static IdProjection`	`id()` Projection used to obtain the id of an object
`static MaxProjection`	`max(java.lang.String name)` Computes the max value of a property
`static MinProjection`	`min(java.lang.String name)` Computes the min value of a property
`static PropertyProjection`	`property(java.lang.String name)` A projection that obtains the value of a property of an entity
`static SumProjection`	`sum(java.lang.String name)` Computes the sum of a property

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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 CountProjection COUNT_PROJECTION
  - public static final IdProjection ID_PROJECTION
- Method Detail
  - public static AvgProjection avg(java.lang.String name)
    
    Computes the average value of a property
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property
  - public static CountProjection count()
    
    Projection that returns the number of records from the query instead of the results themselves
    Returns:
    The CountProjection instance
  - public static CountDistinctProjection countDistinct(java.lang.String property)
    
    Projection that signifies to return only distinct results
    Returns:
    Distinct projection
    Parameters:
    property - The name of the property
  - public static DistinctProjection distinct()
    
    Projection that signifies to return only distinct results
    Returns:
    Distinct projection
  - public static DistinctPropertyProjection distinct(java.lang.String property)
    
    Projection that signifies to return only distinct results
    Returns:
    Distinct projection
    Parameters:
    property - The name of the property
  - public static GroupPropertyProjection 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 static IdProjection id()
    
    Projection used to obtain the id of an object
    Returns:
    The IdProjection instance
  - public static MaxProjection max(java.lang.String name)
    
    Computes the max value of a property
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property
  - public static MinProjection min(java.lang.String name)
    
    Computes the min value of a property
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property
  - public static PropertyProjection property(java.lang.String name)
    
    A projection that obtains the value of a property of an entity
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property
  - public static SumProjection sum(java.lang.String name)
    
    Computes the sum of a property
    Returns:
    The PropertyProjection instance
    Parameters:
    name - The name of the property

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class Projections

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final CountProjection COUNT_PROJECTION

public static final IdProjection ID_PROJECTION

Method Detail

public static AvgProjection avg(java.lang.String name)

public static CountProjection count()

public static CountDistinctProjection countDistinct(java.lang.String property)

public static DistinctProjection distinct()

public static DistinctPropertyProjection distinct(java.lang.String property)

public static GroupPropertyProjection groupProperty(java.lang.String property)

public static IdProjection id()

public static MaxProjection max(java.lang.String name)

public static MinProjection min(java.lang.String name)

public static PropertyProjection property(java.lang.String name)

public static SumProjection sum(java.lang.String name)