AbstractHibernateGormStaticApi (Grace Data Hibernate

org.grails.orm.hibernate.AbstractHibernateGormStaticApi

```
@CompileStatic
abstract class AbstractHibernateGormStaticApi<D>
extends GormStaticApi<D>
```
Abstract implementation of the Hibernate static API for GORM, providing String-based method implementations
Authors:
Graeme Rocher
Michael Yan
Since:
4.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`AbstractHibernateGormStaticApi.1`

Field Summary

Fields
Modifiers	Name	Description
`protected ConversionService`	`conversionService`
`protected HibernateSession`	`hibernateSession`
`protected GrailsHibernateTemplate`	`hibernateTemplate`
`protected ProxyHandler`	`proxyHandler`

Constructor Summary

Constructors
Constructor and description
`AbstractHibernateGormStaticApi(Class<D> persistentClass, HibernateDatastore datastore, List<FinderMethod> finders)`
`AbstractHibernateGormStaticApi(Class<D> persistentClass, HibernateDatastore datastore, List<FinderMethod> finders, PlatformTransactionManager transactionManager)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected String`	`buildNamedParameterQueryFromGString(GString query, Map params)` Processes a query converting GString expressions into parameters
	`protected String`	`buildOrdinalParameterQueryFromGString(GString query, List params)` Processes a query converting GString expressions into parameters
	`protected Serializable`	`convertIdentifier(Serializable id)`
	`Integer`	`count()`
	`protected abstract HibernateHqlQuery`	`createHqlQuery(Session session, Query q)`
	`List`	`executeQuery(CharSequence query)`
	`List`	`executeQuery(CharSequence query, Map args)`
	`List`	`executeQuery(CharSequence query, Map params, Map args)`
	`List`	`executeQuery(CharSequence query, Collection params, Map args)`
	`Integer`	`executeUpdate(CharSequence query)`
	`Integer`	`executeUpdate(CharSequence query, Map args)`
	`boolean`	`exists(Serializable id)`
	`protected Map`	`filterQueryArgumentMap(Map query)`
	`D`	`find(CharSequence query, Map queryNamedArgs, Map args)` Implements the 'find(String' method to use HQL queries with named arguments
	`D`	`find(CharSequence query, Collection params, Map args)`
	`D`	`find(CharSequence query)`
	`D`	`find(CharSequence query, Map params)`
	`D`	`find(D exampleObject, Map args)`
	`List<D>`	`findAll(CharSequence query, Map params, Map args)`
	`List<D>`	`findAll(CharSequence query)`
	`List<D>`	`findAll(CharSequence query, Map params)`
	`List<D>`	`findAll(CharSequence query, Collection params, Map args)`
	`List<D>`	`findAll(D exampleObject, Map args)`
	`List<D>`	`findAllWhere(Map queryMap, Map args)`
	`List<D>`	`findAllWithSql(CharSequence sql, Map args)` Finds all results for this entity for the given SQL query
	`D`	`findWhere(Map queryMap, Map args)`
`<D>`	`D`	`findWithSql(CharSequence sql, Map args)`
	`protected abstract void`	`firePostQueryEvent(Session session, Criteria criteria, Object result)` Fire a post query event
	`protected abstract void`	`firePreQueryEvent(Session session, Criteria criteria)` Fire a pre query event
	`D`	`first(Map m)`
	`D`	`get(Serializable id)`
	`List<D>`	`getAll()`
	`List<D>`	`getAll(List ids)`
	`List<D>`	`getAll(Long[] ids)`
	`List<D>`	`getAll(Serializable[] ids)`
	`IHibernateTemplate`	`getHibernateTemplate()`
	`protected Integer`	`intValue(Map args, String key)`
	`D`	`last(Map m)`
	`D`	`load(Serializable id)`
	`protected void`	`populateQueryArguments(Query q, Map args)`
	`protected void`	`populateQueryWithNamedArguments(Query q, Map queryNamedArgs)`
	`D`	`read(Serializable id)`
	`protected List<String>`	`removeNullNames(Map query)`
`<T>`	`T`	`withNewSession(Closure<T> callable)`
`<T>`	`T`	`withSession(Closure<T> callable)`

- Field Detail
  - protected ConversionService conversionService
  - protected final HibernateSession hibernateSession
  - protected GrailsHibernateTemplate hibernateTemplate
  - protected ProxyHandler proxyHandler
- Constructor Detail
  - AbstractHibernateGormStaticApi(Class<D> persistentClass, HibernateDatastore datastore, List<FinderMethod> finders)
  - AbstractHibernateGormStaticApi(Class<D> persistentClass, HibernateDatastore datastore, List<FinderMethod> finders, PlatformTransactionManager transactionManager)
- Method Detail
  - protected String buildNamedParameterQueryFromGString(GString query, Map params)
    
    Processes a query converting GString expressions into parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The final String
  - protected String buildOrdinalParameterQueryFromGString(GString query, List params)
    
    Processes a query converting GString expressions into parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The final String
  - protected Serializable convertIdentifier(Serializable id)
  - @Override
    Integer count()
  - protected abstract HibernateHqlQuery createHqlQuery(Session session, Query q)
  - @Override
    List executeQuery(CharSequence query)
  - @Override
    List executeQuery(CharSequence query, Map args)
  - @Override
    List executeQuery(CharSequence query, Map params, Map args)
  - @Override
    List executeQuery(CharSequence query, Collection params, Map args)
  - @Override
    Integer executeUpdate(CharSequence query)
  - @Override
    Integer executeUpdate(CharSequence query, Map args)
  - @Override
    boolean exists(Serializable id)
  - protected Map filterQueryArgumentMap(Map query)
  - @Override
    D find(CharSequence query, Map queryNamedArgs, Map args)
    
    Implements the 'find(String' method to use HQL queries with named arguments
    Parameters:
    query - The query
    queryNamedArgs - The named arguments
    args - Any additional query arguments
    Returns:
    A result or null if no result found
  - @Override
    D find(CharSequence query, Collection params, Map args)
  - @Override
    D find(CharSequence query)
  - @Override
    D find(CharSequence query, Map params)
  - @Override
    D find(D exampleObject, Map args)
  - @Override
    List<D> findAll(CharSequence query, Map params, Map args)
  - @Override
    List<D> findAll(CharSequence query)
  - @Override
    List<D> findAll(CharSequence query, Map params)
  - @Override
    List<D> findAll(CharSequence query, Collection params, Map args)
  - @Override
    List<D> findAll(D exampleObject, Map args)
  - @Override
    List<D> findAllWhere(Map queryMap, Map args)
  - @CompileDynamic
    List<D> findAllWithSql(CharSequence sql, Map args)
    
    Finds all results for this entity for the given SQL query
    Parameters:
    sql - The SQL query
    args - The arguments
    Returns:
    All entities matching the SQL query
  - @Override
    D findWhere(Map queryMap, Map args)
  - <D> @CompileDynamic
    D findWithSql(CharSequence sql, Map args)
  - protected abstract void firePostQueryEvent(Session session, Criteria criteria, Object result)
    
    Fire a post query event
    Parameters:
    session - The session
    criteria - The criteria
    result - The result
  - protected abstract void firePreQueryEvent(Session session, Criteria criteria)
    
    Fire a pre query event
    Parameters:
    session - The session
    criteria - The criteria
    Returns:
    True if the query should be cancelled
  - D first(Map m)
  - @Override
    D get(Serializable id)
  - @Override
    List<D> getAll()
  - List<D> getAll(List ids)
  - List<D> getAll(Long[] ids)
  - @Override
    List<D> getAll(Serializable[] ids)
  - IHibernateTemplate getHibernateTemplate()
  - protected Integer intValue(Map args, String key)
  - D last(Map m)
  - @Override
    D load(Serializable id)
  - protected void populateQueryArguments(Query q, Map args)
  - protected void populateQueryWithNamedArguments(Query q, Map queryNamedArgs)
  - @Override
    D read(Serializable id)
  - protected List<String> removeNullNames(Map query)
  - <T> @Override
    T withNewSession(Closure<T> callable)
  - <T> @Override
    T withSession(Closure<T> callable)

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractHibernateGormStaticApi<D>

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Field Detail

protected ConversionService conversionService

protected final HibernateSession hibernateSession

protected GrailsHibernateTemplate hibernateTemplate

protected ProxyHandler proxyHandler

Constructor Detail

AbstractHibernateGormStaticApi(Class<D> persistentClass, HibernateDatastore datastore, List<FinderMethod> finders)

AbstractHibernateGormStaticApi(Class<D> persistentClass, HibernateDatastore datastore, List<FinderMethod> finders, PlatformTransactionManager transactionManager)

Method Detail

protected String buildNamedParameterQueryFromGString(GString query, Map params)

protected String buildOrdinalParameterQueryFromGString(GString query, List params)

protected Serializable convertIdentifier(Serializable id)

@OverrideInteger count()

protected abstract HibernateHqlQuery createHqlQuery(Session session, Query q)

@OverrideList executeQuery(CharSequence query)

@OverrideList executeQuery(CharSequence query, Map args)

@OverrideList executeQuery(CharSequence query, Map params, Map args)

@OverrideList executeQuery(CharSequence query, Collection params, Map args)

@OverrideInteger executeUpdate(CharSequence query)

@OverrideInteger executeUpdate(CharSequence query, Map args)

@Overrideboolean exists(Serializable id)

protected Map filterQueryArgumentMap(Map query)

@OverrideD find(CharSequence query, Map queryNamedArgs, Map args)

@OverrideD find(CharSequence query, Collection params, Map args)

@OverrideD find(CharSequence query)

@OverrideD find(CharSequence query, Map params)

@OverrideD find(D exampleObject, Map args)

@OverrideList<D> findAll(CharSequence query, Map params, Map args)

@OverrideList<D> findAll(CharSequence query)

@OverrideList<D> findAll(CharSequence query, Map params)

@OverrideList<D> findAll(CharSequence query, Collection params, Map args)

@OverrideList<D> findAll(D exampleObject, Map args)

@OverrideList<D> findAllWhere(Map queryMap, Map args)

@CompileDynamicList<D> findAllWithSql(CharSequence sql, Map args)

@OverrideD findWhere(Map queryMap, Map args)

<D> @CompileDynamicD findWithSql(CharSequence sql, Map args)

protected abstract void firePostQueryEvent(Session session, Criteria criteria, Object result)

protected abstract void firePreQueryEvent(Session session, Criteria criteria)

D first(Map m)

@OverrideD get(Serializable id)

@OverrideList<D> getAll()

List<D> getAll(List ids)

List<D> getAll(Long[] ids)

@OverrideList<D> getAll(Serializable[] ids)

IHibernateTemplate getHibernateTemplate()

protected Integer intValue(Map args, String key)

D last(Map m)

@OverrideD load(Serializable id)

protected void populateQueryArguments(Query q, Map args)

protected void populateQueryWithNamedArguments(Query q, Map queryNamedArgs)

@OverrideD read(Serializable id)

protected List<String> removeNullNames(Map query)

<T> @OverrideT withNewSession(Closure<T> callable)

<T> @OverrideT withSession(Closure<T> callable)

@Override
Integer count()

@Override
List executeQuery(CharSequence query)

@Override
List executeQuery(CharSequence query, Map args)

@Override
List executeQuery(CharSequence query, Map params, Map args)

@Override
List executeQuery(CharSequence query, Collection params, Map args)

@Override
Integer executeUpdate(CharSequence query)

@Override
Integer executeUpdate(CharSequence query, Map args)

@Override
boolean exists(Serializable id)

@Override
D find(CharSequence query, Map queryNamedArgs, Map args)

@Override
D find(CharSequence query, Collection params, Map args)

@Override
D find(CharSequence query)

@Override
D find(CharSequence query, Map params)

@Override
D find(D exampleObject, Map args)

@Override
List<D> findAll(CharSequence query, Map params, Map args)

@Override
List<D> findAll(CharSequence query)

@Override
List<D> findAll(CharSequence query, Map params)

@Override
List<D> findAll(CharSequence query, Collection params, Map args)

@Override
List<D> findAll(D exampleObject, Map args)

@Override
List<D> findAllWhere(Map queryMap, Map args)

@CompileDynamic
List<D> findAllWithSql(CharSequence sql, Map args)

@Override
D findWhere(Map queryMap, Map args)

<D> @CompileDynamic
D findWithSql(CharSequence sql, Map args)

@Override
D get(Serializable id)

@Override
List<D> getAll()

@Override
List<D> getAll(Serializable[] ids)

@Override
D load(Serializable id)

@Override
D read(Serializable id)

<T> @Override
T withNewSession(Closure<T> callable)

<T> @Override
T withSession(Closure<T> callable)