GormEnhancer (GORM for Hibernate 5

org.grails.datastore.gorm.GormEnhancer

All Implemented Interfaces and Traits:: java.io.Closeable

@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
class GormEnhancer
extends java.lang.Object
implements java.io.Closeable

Enhances a class with GORM behavior

Authors:: Graeme Rocher

Nested Class Summary

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

Properties Summary

Properties
Type	Name and description
`Datastore`	`datastore`
`boolean`	`dynamicEnhance` Whether to enhance classes dynamically using meta programming as well, only necessary for Java classes
`boolean`	`failOnError`
`java.util.List<FinderMethod>`	`finders`
`boolean`	`includeExternal` Whether to include external entities
`boolean`	`markDirty`
`org.springframework.transaction.PlatformTransactionManager`	`transactionManager`

Constructor Summary

Constructors
Constructor and description
`GormEnhancer(Datastore datastore)`
`GormEnhancer(Datastore datastore, org.springframework.transaction.PlatformTransactionManager transactionManager, boolean failOnError, boolean dynamicEnhance, boolean markDirty)`
`GormEnhancer(Datastore datastore, org.springframework.transaction.PlatformTransactionManager transactionManager, ConnectionSourceSettings settings)` Construct a new GormEnhancer for the given arguments

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addInstanceMethods(PersistentEntity e, boolean onlyExtendedMethods)`
	`protected void`	`addStaticMethods(PersistentEntity e, boolean onlyExtendedMethods)`
	`java.util.List<java.lang.String>`	`allQualifiers(Datastore datastore, PersistentEntity entity)` Obtain all of the qualifiers (typically the connection names) for the datastore and entity
	`protected boolean`	`appliesToDatastore(Datastore datastore, PersistentEntity entity)`
	`void`	`close()` Closes the enhancer clearing any stored static state
	`protected java.util.List<FinderMethod>`	`createDynamicFinders()`
	`protected java.util.List<FinderMethod>`	`createDynamicFinders(Datastore targetDatastore)`
	`static GormQueryOperations`	`createNamedQuery(java.lang.Class entity, java.lang.String queryName)` Finds a named query for the given entity
	`static GormQueryOperations`	`createNamedQuery(java.lang.Class entity, java.lang.String queryName, java.lang.Object[] args)` Finds a named query for the given entity
	`protected static boolean`	`doesRealMethodExist(groovy.lang.MetaClass mc, java.lang.String methodName, java.lang.Class[] parameterTypes, boolean staticScope)`
	`void`	`enhance(boolean onlyExtendedMethods)` Enhances all persistent entities.
	`void`	`enhance(PersistentEntity e, boolean onlyExtendedMethods)` Enhance and individual entity
	`static Datastore`	`findDatastore(java.lang.Class entity, java.lang.String qualifier)` Find a datastore for the give entity type and qualifier (the connection name)
	`static Datastore`	`findDatastoreByType(java.lang.Class<? extends Datastore> datastoreType)` Finds a datastore by type
	`static PersistentEntity`	`findEntity(java.lang.Class entity, java.lang.String qualifier)` Find the entity for the given type
`<D>`	`static GormInstanceApi<D>`	`findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)` Find an instance API for the give entity type and qualifier (the connection name)
	`static GormQueryOperations`	`findNamedQuery(java.lang.Class entity, java.lang.String queryName)` deprecated: Use #createNamedQuery(entity, queryName) instead
	`static Datastore`	`findSingleDatastore()` Finds a single datastore
	`static org.springframework.transaction.PlatformTransactionManager`	`findSingleTransactionManager(java.lang.String connectionName)` Finds a single available transaction manager
`<D>`	`static GormStaticApi<D>`	`findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)` Find a static API for the give entity type and qualifier (the connection name)
	`protected static java.lang.String`	`findTenantId(java.lang.Class entity)` Find the tenant id for the given entity
	`static org.springframework.transaction.PlatformTransactionManager`	`findTransactionManager(java.lang.Class<? extends Datastore> datastoreType, java.lang.String connectionName)` Finds a single available transaction manager
`<D>`	`static GormValidationApi<D>`	`findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)` Find a validation API for the give entity type and qualifier (the connection name)
	`java.util.List<FinderMethod>`	`getFinders()`
`<D>`	`protected GormInstanceApi<D>`	`getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)`
`<D>`	`protected java.util.List<AbstractGormApi<D>>`	`getInstanceMethodApiProviders(java.lang.Class<D> cls)`
`<D>`	`protected GormStaticApi<D>`	`getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)`
`<D>`	`protected GormValidationApi<D>`	`getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)`
	`protected static boolean`	`isRealMethod(groovy.lang.MetaMethod existingMethod)`
	`protected void`	`registerConstraints(Datastore datastore)`
	`void`	`registerEntity(PersistentEntity entity)` Registers a new entity with the GORM enhancer
	`protected java.lang.Object`	`registerInstanceMethod(java.lang.Class cls, groovy.lang.ExpandoMetaClass mc, AbstractGormApi apiProvider, java.lang.String methodName, java.lang.Class[] parameterTypes)`
	`protected void`	`registerStaticMethod(groovy.lang.ExpandoMetaClass mc, java.lang.String methodName, java.lang.Class<?>[] parameterTypes, GormStaticApi staticApiProvider)`
	`protected void`	`removeConstraints()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), 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()`

- Property Detail
  - final Datastore datastore
  - final boolean dynamicEnhance
    
    Whether to enhance classes dynamically using meta programming as well, only necessary for Java classes
  - boolean failOnError
  - java.util.List<FinderMethod> finders
  - boolean includeExternal
    
    Whether to include external entities
  - boolean markDirty
  - org.springframework.transaction.PlatformTransactionManager transactionManager
- Constructor Detail
  - GormEnhancer(Datastore datastore)
  - GormEnhancer(Datastore datastore, org.springframework.transaction.PlatformTransactionManager transactionManager, boolean failOnError, boolean dynamicEnhance, boolean markDirty)
  - GormEnhancer(Datastore datastore, org.springframework.transaction.PlatformTransactionManager transactionManager, ConnectionSourceSettings settings)
    
    Construct a new GormEnhancer for the given arguments
    Parameters:
    datastore - The datastore
    transactionManager - The transaction manager
    settings - The settings
- Method Detail
  - @groovy.transform.CompileStatic
    protected void addInstanceMethods(PersistentEntity e, boolean onlyExtendedMethods)
  - @groovy.transform.CompileStatic
    protected void addStaticMethods(PersistentEntity e, boolean onlyExtendedMethods)
  - java.util.List<java.lang.String> allQualifiers(Datastore datastore, PersistentEntity entity)
    
    Obtain all of the qualifiers (typically the connection names) for the datastore and entity
    Parameters:
    datastore - The datastore
    entity - The entity
    Returns:
    The qualifiers
  - protected boolean appliesToDatastore(Datastore datastore, PersistentEntity entity)
  - @java.lang.Override
    @groovy.transform.CompileStatic
    void close()
    
    Closes the enhancer clearing any stored static state
    throws:
    IOException
  - @groovy.transform.CompileStatic
    protected java.util.List<FinderMethod> createDynamicFinders()
  - @groovy.transform.CompileStatic
    protected java.util.List<FinderMethod> createDynamicFinders(Datastore targetDatastore)
  - static GormQueryOperations createNamedQuery(java.lang.Class entity, java.lang.String queryName)
    
    Finds a named query for the given entity
    Parameters:
    entity - The entity name
    queryName - The query name
    Returns:
    The named query or null if it doesn't exist
  - static GormQueryOperations createNamedQuery(java.lang.Class entity, java.lang.String queryName, java.lang.Object[] args)
    
    Finds a named query for the given entity
    Parameters:
    entity - The entity name
    queryName - The query name
    Returns:
    The named query or null if it doesn't exist
  - @groovy.transform.CompileStatic
    protected static boolean doesRealMethodExist(groovy.lang.MetaClass mc, java.lang.String methodName, java.lang.Class[] parameterTypes, boolean staticScope)
  - @groovy.transform.CompileStatic
    void enhance(boolean onlyExtendedMethods)
    
    Enhances all persistent entities.
    Parameters:
    onlyExtendedMethods - If only to add additional methods provides by subclasses of the GORM APIs
  - @groovy.transform.CompileStatic
    void enhance(PersistentEntity e, boolean onlyExtendedMethods)
    
    Enhance and individual entity
    Parameters:
    e - The entity
    onlyExtendedMethods - If only to add additional methods provides by subclasses of the GORM APIs
  - static Datastore findDatastore(java.lang.Class entity, java.lang.String qualifier)
    
    Find a datastore for the give entity type and qualifier (the connection name)
    throws:
    IllegalStateException if no datastore is found for the type
    
    Parameters:
    entity - The entity class
    qualifier - The qualifier
    Returns:
    A datastore
  - static Datastore findDatastoreByType(java.lang.Class<? extends Datastore> datastoreType)
    
    Finds a datastore by type
    throws:
    IllegalStateException If no datastore is found for the type
    
    Parameters:
    datastoreType - The datastore type
    Returns:
    The datastore
  - static PersistentEntity findEntity(java.lang.Class entity, java.lang.String qualifier)
    
    Find the entity for the given type
    throws:
    IllegalStateException if no entity is found for the type
    
    Parameters:
    entity - The entity class
    qualifier - The qualifier
    Returns:
    A entity
  - <D> static GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)
    
    Find an instance API for the give entity type and qualifier (the connection name)
    throws:
    IllegalStateException if no instance API is found for the type
    
    Parameters:
    entity - The entity class
    qualifier - The qualifier
    Returns:
    An instance API
  - @java.lang.Deprecated
    static GormQueryOperations findNamedQuery(java.lang.Class entity, java.lang.String queryName)
    
    deprecated:
    Use #createNamedQuery(entity, queryName) instead
  - static Datastore findSingleDatastore()
    
    Finds a single datastore
    throws:
    IllegalStateException If no datastore is found or more than one is configured
  - static org.springframework.transaction.PlatformTransactionManager findSingleTransactionManager(java.lang.String connectionName)
    
    Finds a single available transaction manager
    throws:
    TransactionSystemException If the current implementation does not support transactions
    throws:
    IllegalStateException If no GORM implementation has been bootstrapped and configured
    
    Returns:
    The transaction manager
  - <D> static GormStaticApi<D> findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)
    
    Find a static API for the give entity type and qualifier (the connection name)
    throws:
    IllegalStateException if no static API is found for the type
    
    Parameters:
    entity - The entity class
    qualifier - The qualifier
    Returns:
    A static API
  - protected static java.lang.String findTenantId(java.lang.Class entity)
    
    Find the tenant id for the given entity @return
    Parameters:
    entity
  - static org.springframework.transaction.PlatformTransactionManager findTransactionManager(java.lang.Class<? extends Datastore> datastoreType, java.lang.String connectionName)
    
    Finds a single available transaction manager
    throws:
    TransactionSystemException If the current implementation does not support transactions
    throws:
    IllegalStateException If no GORM implementation has been bootstrapped and configured
    
    Returns:
    The transaction manager
  - <D> static GormValidationApi<D> findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)
    
    Find a validation API for the give entity type and qualifier (the connection name)
    throws:
    IllegalStateException if no validation API is found for the type
    
    Parameters:
    entity - The entity class
    qualifier - The qualifier
    Returns:
    A validation API
  - @groovy.transform.CompileStatic
    java.util.List<FinderMethod> getFinders()
  - <D> @groovy.transform.CompileStatic
    protected GormInstanceApi<D> getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - <D> @groovy.transform.CompileDynamic
    protected java.util.List<AbstractGormApi<D>> getInstanceMethodApiProviders(java.lang.Class<D> cls)
  - <D> @groovy.transform.CompileStatic
    protected GormStaticApi<D> getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - <D> @groovy.transform.CompileStatic
    protected GormValidationApi<D> getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - @groovy.transform.CompileStatic
    protected static boolean isRealMethod(groovy.lang.MetaMethod existingMethod)
  - protected void registerConstraints(Datastore datastore)
  - void registerEntity(PersistentEntity entity)
    
    Registers a new entity with the GORM enhancer
    Parameters:
    entity - The entity
  - protected java.lang.Object registerInstanceMethod(java.lang.Class cls, groovy.lang.ExpandoMetaClass mc, AbstractGormApi apiProvider, java.lang.String methodName, java.lang.Class[] parameterTypes)
  - @groovy.transform.CompileDynamic
    protected void registerStaticMethod(groovy.lang.ExpandoMetaClass mc, java.lang.String methodName, java.lang.Class<?>[] parameterTypes, GormStaticApi staticApiProvider)
  - @groovy.transform.CompileDynamic
    protected void removeConstraints()

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GormEnhancer

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final Datastore datastore

final boolean dynamicEnhance

boolean failOnError

java.util.List<FinderMethod> finders

boolean includeExternal

boolean markDirty

org.springframework.transaction.PlatformTransactionManager transactionManager

Constructor Detail

GormEnhancer(Datastore datastore)

GormEnhancer(Datastore datastore, org.springframework.transaction.PlatformTransactionManager transactionManager, boolean failOnError, boolean dynamicEnhance, boolean markDirty)

GormEnhancer(Datastore datastore, org.springframework.transaction.PlatformTransactionManager transactionManager, ConnectionSourceSettings settings)

Method Detail

@groovy.transform.CompileStaticprotected void addInstanceMethods(PersistentEntity e, boolean onlyExtendedMethods)

@groovy.transform.CompileStaticprotected void addStaticMethods(PersistentEntity e, boolean onlyExtendedMethods)

java.util.List<java.lang.String> allQualifiers(Datastore datastore, PersistentEntity entity)

protected boolean appliesToDatastore(Datastore datastore, PersistentEntity entity)

@java.lang.Override@groovy.transform.CompileStaticvoid close()

@groovy.transform.CompileStaticprotected java.util.List<FinderMethod> createDynamicFinders()

@groovy.transform.CompileStaticprotected java.util.List<FinderMethod> createDynamicFinders(Datastore targetDatastore)

static GormQueryOperations createNamedQuery(java.lang.Class entity, java.lang.String queryName)

static GormQueryOperations createNamedQuery(java.lang.Class entity, java.lang.String queryName, java.lang.Object[] args)

@groovy.transform.CompileStaticprotected static boolean doesRealMethodExist(groovy.lang.MetaClass mc, java.lang.String methodName, java.lang.Class[] parameterTypes, boolean staticScope)

@groovy.transform.CompileStaticvoid enhance(boolean onlyExtendedMethods)

@groovy.transform.CompileStaticvoid enhance(PersistentEntity e, boolean onlyExtendedMethods)

static Datastore findDatastore(java.lang.Class entity, java.lang.String qualifier)

static Datastore findDatastoreByType(java.lang.Class<? extends Datastore> datastoreType)

static PersistentEntity findEntity(java.lang.Class entity, java.lang.String qualifier)

<D> static GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)

@java.lang.Deprecatedstatic GormQueryOperations findNamedQuery(java.lang.Class entity, java.lang.String queryName)

static Datastore findSingleDatastore()

static org.springframework.transaction.PlatformTransactionManager findSingleTransactionManager(java.lang.String connectionName)

<D> static GormStaticApi<D> findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)

protected static java.lang.String findTenantId(java.lang.Class entity)

static org.springframework.transaction.PlatformTransactionManager findTransactionManager(java.lang.Class<? extends Datastore> datastoreType, java.lang.String connectionName)

<D> static GormValidationApi<D> findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)

@groovy.transform.CompileStaticjava.util.List<FinderMethod> getFinders()

<D> @groovy.transform.CompileStaticprotected GormInstanceApi<D> getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)

<D> @groovy.transform.CompileDynamicprotected java.util.List<AbstractGormApi<D>> getInstanceMethodApiProviders(java.lang.Class<D> cls)

<D> @groovy.transform.CompileStaticprotected GormStaticApi<D> getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)

<D> @groovy.transform.CompileStaticprotected GormValidationApi<D> getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)

@groovy.transform.CompileStaticprotected static boolean isRealMethod(groovy.lang.MetaMethod existingMethod)

protected void registerConstraints(Datastore datastore)

void registerEntity(PersistentEntity entity)

protected java.lang.Object registerInstanceMethod(java.lang.Class cls, groovy.lang.ExpandoMetaClass mc, AbstractGormApi apiProvider, java.lang.String methodName, java.lang.Class[] parameterTypes)

@groovy.transform.CompileDynamicprotected void registerStaticMethod(groovy.lang.ExpandoMetaClass mc, java.lang.String methodName, java.lang.Class<?>[] parameterTypes, GormStaticApi staticApiProvider)

@groovy.transform.CompileDynamicprotected void removeConstraints()

@groovy.transform.CompileStatic
protected void addInstanceMethods(PersistentEntity e, boolean onlyExtendedMethods)

@groovy.transform.CompileStatic
protected void addStaticMethods(PersistentEntity e, boolean onlyExtendedMethods)

@java.lang.Override
@groovy.transform.CompileStatic
void close()

@groovy.transform.CompileStatic
protected java.util.List<FinderMethod> createDynamicFinders()

@groovy.transform.CompileStatic
protected java.util.List<FinderMethod> createDynamicFinders(Datastore targetDatastore)

@groovy.transform.CompileStatic
protected static boolean doesRealMethodExist(groovy.lang.MetaClass mc, java.lang.String methodName, java.lang.Class[] parameterTypes, boolean staticScope)

@groovy.transform.CompileStatic
void enhance(boolean onlyExtendedMethods)

@groovy.transform.CompileStatic
void enhance(PersistentEntity e, boolean onlyExtendedMethods)

@java.lang.Deprecated
static GormQueryOperations findNamedQuery(java.lang.Class entity, java.lang.String queryName)

@groovy.transform.CompileStatic
java.util.List<FinderMethod> getFinders()

<D> @groovy.transform.CompileStatic
protected GormInstanceApi<D> getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)

<D> @groovy.transform.CompileDynamic
protected java.util.List<AbstractGormApi<D>> getInstanceMethodApiProviders(java.lang.Class<D> cls)

<D> @groovy.transform.CompileStatic
protected GormStaticApi<D> getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)

<D> @groovy.transform.CompileStatic
protected GormValidationApi<D> getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)

@groovy.transform.CompileStatic
protected static boolean isRealMethod(groovy.lang.MetaMethod existingMethod)

@groovy.transform.CompileDynamic
protected void registerStaticMethod(groovy.lang.ExpandoMetaClass mc, java.lang.String methodName, java.lang.Class<?>[] parameterTypes, GormStaticApi staticApiProvider)

@groovy.transform.CompileDynamic
protected void removeConstraints()