Entity (Grace Data - 2024.1.0-RC1)

org.grails.datastore.mapping.config.Entity

```
@CompileStatic
@SettingsBuilder
class Entity
extends Object
```
Base class for classes returned from ClassMapping.getMappedForm
Authors:
Graeme Rocher
Since:
1.1.9

Field Summary

Fields
Modifiers	Name	Description
`protected Map<String, P>`	`propertyConfigs`	The configuration for each property

Properties Summary

Properties
Type	Name and description
`boolean`	`autoTimestamp` Returns: Whether automatic time stamps should be applied to 'lastUpdate' and 'dateCreated' properties
`boolean`	`autowire` Returns: Whether the entity should be autowired
`List<String>`	`datasources` Get the datasource names that this domain class works with.
`Object`	`defaultSort` Returns: The default sort order definition, could be a string or a map
`Object`	`sort`
`boolean`	`stateless` Returns: Whether the entity state should be held in the session or not
`boolean`	`version` Returns: Whether the entity is versioned

Constructor Summary

Constructors
Constructor and description
`Entity()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected P`	`cloneGlobalConstraint()`
`<T extends Entity>`	`static T`	`configureExisting(T mapping, Closure config)` Configures an existing Mapping instance
	`Entity<P>`	`connection(String name)` Sets the datastore to use
	`Entity<P>`	`connections(String[] names)` Sets the connection to use
	`Entity<P>`	`connections(List<String> names)` Sets the connection to use
	`Entity<P>`	`datasource(String name)` Sets the datastore to use
	`protected P`	`getOrInitializePropertyConfig(String name)`
	`P`	`getPropertyConfig(String name)` Get a property config
	`Map<String, P>`	`getPropertyConfigs()` Returns: The property configurations
	`Object`	`getSort()`
	`Entity<P>`	`id(Map identityConfig)` Define the identity config
	`Entity<P>`	`id(Closure identityConfig)` Define the identity config
	`boolean`	`isVersioned()` Returns: Whether this entity is versioned
	`Object`	`methodMissing(String name, Object args)`
	`protected P`	`newProperty()`
	`Entity<P>`	`property(String name, Closure propertyConfig)` Configure a property
	`Entity<P>`	`property(String name, Map propertyConfig)` Configure a property
	`P`	`property(Closure propertyConfig)` Configure a new property
	`P`	`property(Map propertyConfig)` Configure a new property
	`Object`	`propertyMissing(String name, Object val)`
	`Entity<P>`	`setSort(Object defaultSort)`
	`Entity<P>`	`tenantId(String tenantIdProperty)` Sets the tenant id
	`Entity<P>`	`version(Closure versionConfig)`
	`Entity<P>`	`version(Map versionConfig)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
 - protected Map<String, P> propertyConfigs
 
 The configuration for each property
- Property Detail
 - boolean autoTimestamp
 
 Returns:
 Whether automatic time stamps should be applied to 'lastUpdate' and 'dateCreated' properties
 - boolean autowire
 
 Returns:
 Whether the entity should be autowired
 - List<String> datasources
 
 Get the datasource names that this domain class works with.
 Returns:
 the datasource names
 - Object defaultSort
 
 Returns:
 The default sort order definition, could be a string or a map
 - Object sort
 - boolean stateless
 
 Returns:
 Whether the entity state should be held in the session or not
 - boolean version
 
 Returns:
 Whether the entity is versioned
- Constructor Detail
 - Entity()
- Method Detail
 - protected P cloneGlobalConstraint()
 - <T extends Entity> static T configureExisting(@DelegatesTo.Target
 T mapping, @DelegatesTo(genericTypeIndex: 0)
 Closure config)
 
 Configures an existing Mapping instance
 Parameters:
 config - The configuration
 Returns:
 The new instance
 - Entity connection(String name)
 
 Sets the datastore to use @return
 Parameters:
 name
 - Entity connections(String[] names)
 
 Sets the connection to use @return
 Parameters:
 name
 - Entity connections(List<String> names)
 
 Sets the connection to use @return
 Parameters:
 name
 - Entity datasource(String name)
 
 Sets the datastore to use @return
 Parameters:
 name
 - protected P getOrInitializePropertyConfig(String name)
 - P getPropertyConfig(String name)
 
 Get a property config @return
 Parameters:
 name - The name of the property
 - Map<String, P> getPropertyConfigs()
 
 Returns:
 The property configurations
 - Object getSort()
 - Entity id(Map identityConfig)
 
 Define the identity config
 Parameters:
 identityConfig - The id config
 Returns:
 This mapping
 - Entity id(@DelegatesTo(type: P)
 Closure identityConfig)
 
 Define the identity config
 Parameters:
 identityConfig - The id config
 Returns:
 This mapping
 - boolean isVersioned()
 
 Returns:
 Whether this entity is versioned
 - @CompileDynamic
 Object methodMissing(String name, Object args)
 - protected P newProperty()
 - Entity property(String name, @DelegatesTo(type: P)
 Closure propertyConfig)
 
 Configure a property
 Parameters:
 name - The name of the property
 propertyConfig - The property config
 Returns:
 This mapping
 - Entity property(String name, Map propertyConfig)
 
 Configure a property
 Parameters:
 name - The name of the property
 propertyConfig - The property config
 Returns:
 This mapping
 - P property(@DelegatesTo(type: P)
 Closure propertyConfig)
 
 Configure a new property
 Parameters:
 name - The name of the property
 propertyConfig - The property config
 Returns:
 This mapping
 - P property(Map propertyConfig)
 
 Configure a new property
 Parameters:
 name - The name of the property
 propertyConfig - The property config
 Returns:
 This mapping
 - Object propertyMissing(String name, Object val)
 - Entity setSort(Object defaultSort)
 - Entity tenantId(String tenantIdProperty)
 
 Sets the tenant id
 Parameters:
 tenantIdProperty - The tenant id property
 - Entity version(@DelegatesTo(type: P)
 Closure versionConfig)
 
 Configures the name of the version column { version 'foo' }
 Parameters:
 isVersioned - True if a version property should be configured
 Entity version(Map versionConfig) Configures the name of the version column { version 'foo' } Parameters: isVersioned - True if a version property should be configured






    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    



    
        
            Frames
            No Frames
        
    
    
        
            Summary: 
            Nested   Field
   Property
   Constructor
   Method   
        
        
             | Detail: 
            Field
   Property
   Constructor
   Method   
        
    
    Groovy Documentation

[Groovy] Class Entity<P extends Property>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected Map<String, P> propertyConfigs

Property Detail

boolean autoTimestamp

boolean autowire

List<String> datasources

Object defaultSort

Object sort

boolean stateless

boolean version

Constructor Detail

Entity()

Method Detail

protected P cloneGlobalConstraint()

<T extends Entity> static T configureExisting(@DelegatesTo.TargetT mapping, @DelegatesTo(genericTypeIndex: 0)Closure config)

Entity<P> connection(String name)

Entity<P> connections(String[] names)

Entity<P> connections(List<String> names)

Entity<P> datasource(String name)

protected P getOrInitializePropertyConfig(String name)

P getPropertyConfig(String name)

Map<String, P> getPropertyConfigs()

Object getSort()

Entity<P> id(Map identityConfig)

Entity<P> id(@DelegatesTo(type: P)Closure identityConfig)

boolean isVersioned()

@CompileDynamicObject methodMissing(String name, Object args)

protected P newProperty()

Entity<P> property(String name, @DelegatesTo(type: P)Closure propertyConfig)

Entity<P> property(String name, Map propertyConfig)

P property(@DelegatesTo(type: P)Closure propertyConfig)

P property(Map propertyConfig)

Object propertyMissing(String name, Object val)

Entity<P> setSort(Object defaultSort)

Entity<P> tenantId(String tenantIdProperty)

Entity<P> version(@DelegatesTo(type: P)Closure versionConfig)

Entity<P> version(Map versionConfig)

<T extends Entity> static T configureExisting(@DelegatesTo.Target
T mapping, @DelegatesTo(genericTypeIndex: 0)
Closure config)

Entity<P> id(@DelegatesTo(type: P)
Closure identityConfig)

@CompileDynamic
Object methodMissing(String name, Object args)

Entity<P> property(String name, @DelegatesTo(type: P)
Closure propertyConfig)

P property(@DelegatesTo(type: P)
Closure propertyConfig)

Entity<P> version(@DelegatesTo(type: P)
Closure versionConfig)