GormEnhancer (Grails 8.0.0-SNAPSHOT)

org.grails.datastore.gorm.GormEnhancer

All Implemented Interfaces and Traits:

java.io.Closeable
```
@groovy.transform.CompileStatic
class GormEnhancer
extends java.lang.Object
implements java.io.Closeable
```
Enhances a class with GORM methods
Authors:
Graeme Rocher

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`
`boolean`	`includeExternal` Whether to include external entities
`boolean`	`markDirty`
`PlatformTransactionManager`	`transactionManager` Retained for API compatibility.

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addInstanceMethods(PersistentEntity e)`
	`protected void`	`addStaticMethods(PersistentEntity e)`
	`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
	`void`	`close()` Closes the enhancer clearing any stored static state
	`protected java.util.List<FinderMethod>`	`createDynamicFinders()`
	`protected java.util.List<FinderMethod>`	`createDynamicFinders(Datastore targetDatastore)`
	`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)`
	`static Datastore`	`findDatastore(java.lang.Class entity, java.lang.String qualifier)`
	`static PersistentEntity`	`findEntity(java.lang.Class entity)`
`<D>`	`static GormInstanceApi<D>`	`findInstanceApi(java.lang.Class<D> entity)`
`<D>`	`static GormInstanceApi<D>`	`findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)`
`<D>`	`static GormStaticApi<D>`	`findStaticApi(java.lang.Class<D> entity)`
`<D>`	`static GormStaticApi<D>`	`findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)`
`<D>`	`static GormValidationApi<D>`	`findValidationApi(java.lang.Class<D> entity)`
`<D>`	`static GormValidationApi<D>`	`findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)`
	`java.util.List<java.lang.String>`	`getConnectionSourceNames()`
`<D>`	`protected GormInstanceApi<D>`	`getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)`
	`static GormRegistry`	`getRegistry()` Returns: The GORM registry instance
`<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 void`	`registerApiFactories()` Registers the GormApiFactory implementations this enhancer's datastore needs, before any entity is registered.
	`protected void`	`registerConstraints(Datastore datastore)`
	`void`	`registerEntity(PersistentEntity entity)` Registers a new entity with the GORM enhancer

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- 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
  - boolean includeExternal
    
    Whether to include external entities
  - boolean markDirty
  - @java.lang.Deprecated
    final PlatformTransactionManager transactionManager
    
    Retained for API compatibility. The registry-based enhancer no longer uses the transaction manager directly; obtain it from the GORM APIs instead.
- Constructor Detail
  - GormEnhancer(Datastore datastore)
  - GormEnhancer(Datastore datastore, PlatformTransactionManager transactionManager, boolean failOnError, boolean dynamicEnhance, boolean markDirty)
  - GormEnhancer(Datastore datastore, PlatformTransactionManager transactionManager, ConnectionSourceSettings settings, GormRegistry registry)
    
    Construct a new GormEnhancer for the given arguments.
    Parameters:
    datastore - The datastore (required)
    transactionManager - Retained for constructor compatibility
    settings - The connection source settings (required)
    registry - The GORM registry (optional, defaults to singleton instance)
- Method Detail
  - @groovy.transform.CompileDynamic
    protected void addInstanceMethods(PersistentEntity e)
  - @groovy.transform.CompileDynamic
    protected void addStaticMethods(PersistentEntity e)
  - @groovy.transform.CompileDynamic
    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
  - @groovy.transform.CompileStatic
    void close()
    
    Closes the enhancer clearing any stored static state
  - @java.lang.Deprecated
    @groovy.transform.CompileStatic
    protected java.util.List<FinderMethod> createDynamicFinders()
  - @java.lang.Deprecated
    @groovy.transform.CompileStatic
    protected java.util.List<FinderMethod> createDynamicFinders(Datastore targetDatastore)
  - void enhance(boolean onlyExtendedMethods)
    
    Enhances all persistent entities.
    Parameters:
    onlyExtendedMethods - If only to add additional methods provides by subclasses of the GORM APIs
  - 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
  - @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static Datastore findDatastore(java.lang.Class entity)
  - @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static Datastore findDatastore(java.lang.Class entity, java.lang.String qualifier)
  - static PersistentEntity findEntity(java.lang.Class entity)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static GormStaticApi<D> findStaticApi(java.lang.Class<D> entity)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static GormStaticApi<D> findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static GormValidationApi<D> findValidationApi(java.lang.Class<D> entity)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    static GormValidationApi<D> findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)
  - java.util.List<java.lang.String> getConnectionSourceNames()
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    protected GormInstanceApi<D> getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - static GormRegistry getRegistry()
    
    Returns:
    The GORM registry instance
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    protected GormStaticApi<D> getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - <D> @java.lang.Deprecated
    @groovy.transform.CompileStatic
    protected GormValidationApi<D> getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - protected void registerApiFactories()
    
    Registers the GormApiFactory implementations this enhancer's datastore needs, before any entity is registered. Adapters that build specialised API objects (for example Mongo's MongoStaticApi, which MongoEntity casts to) override this. It is deliberately separate from registerConstraints(Datastore): factory registration has nothing to do with constraints, and hanging it off the constraints hook would break the moment a subclass reordered or skipped that step.
  - @groovy.transform.CompileDynamic
    protected void registerConstraints(Datastore datastore)
  - void registerEntity(PersistentEntity entity)
    
    Registers a new entity with the GORM enhancer
    Parameters:
    entity - The entity

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class GormEnhancer

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final Datastore datastore

final boolean dynamicEnhance

boolean failOnError

boolean includeExternal

boolean markDirty

@java.lang.Deprecatedfinal PlatformTransactionManager transactionManager

Constructor Detail

GormEnhancer(Datastore datastore)

GormEnhancer(Datastore datastore, PlatformTransactionManager transactionManager, boolean failOnError, boolean dynamicEnhance, boolean markDirty)

GormEnhancer(Datastore datastore, PlatformTransactionManager transactionManager, ConnectionSourceSettings settings, GormRegistry registry)

Method Detail

@groovy.transform.CompileDynamicprotected void addInstanceMethods(PersistentEntity e)

@groovy.transform.CompileDynamicprotected void addStaticMethods(PersistentEntity e)

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

@groovy.transform.CompileStaticvoid close()

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

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

void enhance(boolean onlyExtendedMethods)

void enhance(PersistentEntity e, boolean onlyExtendedMethods)

@java.lang.Deprecated@groovy.transform.CompileStaticstatic Datastore findDatastore(java.lang.Class entity)

@java.lang.Deprecated@groovy.transform.CompileStaticstatic Datastore findDatastore(java.lang.Class entity, java.lang.String qualifier)

static PersistentEntity findEntity(java.lang.Class entity)

<D> @java.lang.Deprecated@groovy.transform.CompileStaticstatic GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity)

<D> @java.lang.Deprecated@groovy.transform.CompileStaticstatic GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)

<D> @java.lang.Deprecated@groovy.transform.CompileStaticstatic GormStaticApi<D> findStaticApi(java.lang.Class<D> entity)

<D> @java.lang.Deprecated@groovy.transform.CompileStaticstatic GormStaticApi<D> findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)

<D> @java.lang.Deprecated@groovy.transform.CompileStaticstatic GormValidationApi<D> findValidationApi(java.lang.Class<D> entity)

<D> @java.lang.Deprecated@groovy.transform.CompileStaticstatic GormValidationApi<D> findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)

java.util.List<java.lang.String> getConnectionSourceNames()

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

static GormRegistry getRegistry()

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

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

protected void registerApiFactories()

@groovy.transform.CompileDynamicprotected void registerConstraints(Datastore datastore)

void registerEntity(PersistentEntity entity)

@java.lang.Deprecated
final PlatformTransactionManager transactionManager

@groovy.transform.CompileDynamic
protected void addInstanceMethods(PersistentEntity e)

@groovy.transform.CompileDynamic
protected void addStaticMethods(PersistentEntity e)

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

@groovy.transform.CompileStatic
void close()

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

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

@java.lang.Deprecated
@groovy.transform.CompileStatic
static Datastore findDatastore(java.lang.Class entity)

@java.lang.Deprecated
@groovy.transform.CompileStatic
static Datastore findDatastore(java.lang.Class entity, java.lang.String qualifier)

<D> @java.lang.Deprecated
@groovy.transform.CompileStatic
static GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity)

<D> @java.lang.Deprecated
@groovy.transform.CompileStatic
static GormInstanceApi<D> findInstanceApi(java.lang.Class<D> entity, java.lang.String qualifier)

<D> @java.lang.Deprecated
@groovy.transform.CompileStatic
static GormStaticApi<D> findStaticApi(java.lang.Class<D> entity)

<D> @java.lang.Deprecated
@groovy.transform.CompileStatic
static GormStaticApi<D> findStaticApi(java.lang.Class<D> entity, java.lang.String qualifier)

<D> @java.lang.Deprecated
@groovy.transform.CompileStatic
static GormValidationApi<D> findValidationApi(java.lang.Class<D> entity)

<D> @java.lang.Deprecated
@groovy.transform.CompileStatic
static GormValidationApi<D> findValidationApi(java.lang.Class<D> entity, java.lang.String qualifier)

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

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

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

@groovy.transform.CompileDynamic
protected void registerConstraints(Datastore datastore)