Entity (GORM for Hibernate 5

org.grails.datastore.mapping.config.Entity

@groovy.transform.CompileStatic
@groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: )
class Entity<P extends Property>
extends java.lang.Object

Base class for classes returned from ClassMapping.getMappedForm

Authors:: Graeme Rocher

Since:: 1.1.9

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`ALL_DATA_SOURCES`	deprecated: Use ConnectionSource#DEFAULT#DEFAULT instead
`static java.lang.String`	`DEFAULT_DATA_SOURCE`	deprecated: Use ConnectionSource#ALL#ALL instead
`protected java.util.Map<java.lang.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
`java.util.List<java.lang.String>`	`datasources` Get the datasource names that this domain class works with.
`java.lang.Object`	`defaultSort` Returns: The default sort order definition, could be a string or a map
`java.lang.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, groovy.lang.Closure config)` Configures an existing Mapping instance
	`Entity`	`connection(java.lang.String name)` Sets the datastore to use
	`Entity`	`connections(java.lang.String[] names)` Sets the connection to use
	`Entity`	`connections(java.util.List<java.lang.String> names)` Sets the connection to use
	`Entity`	`datasource(java.lang.String name)` Sets the datastore to use
	`protected P`	`getOrInitializePropertyConfig(java.lang.String name)`
	`P`	`getPropertyConfig(java.lang.String name)` Get a property config
	`java.util.Map<java.lang.String, P>`	`getPropertyConfigs()` Returns: The property configurations
	`java.lang.Object`	`getSort()`
	`Entity<P>`	`id(java.util.Map identityConfig)` Define the identity config
	`Entity<P>`	`id(groovy.lang.Closure identityConfig)` Define the identity config
	`boolean`	`isVersioned()` Returns: Whether this entity is versioned
	`java.lang.Object`	`methodMissing(java.lang.String name, java.lang.Object args)`
	`protected P`	`newProperty()`
	`Entity`	`property(java.lang.String name, groovy.lang.Closure propertyConfig)` Configure a property
	`Entity`	`property(java.lang.String name, java.util.Map propertyConfig)` Configure a property
	`P`	`property(groovy.lang.Closure propertyConfig)` Configure a new property
	`P`	`property(java.util.Map propertyConfig)` Configure a new property
	`java.lang.Object`	`propertyMissing(java.lang.String name, java.lang.Object val)`
	`Entity`	`setSort(java.lang.Object defaultSort)`
	`Entity`	`tenantId(java.lang.String tenantIdProperty)` Sets the tenant id
	`Entity`	`version(groovy.lang.Closure versionConfig)`
	`Entity`	`version(java.util.Map versionConfig)`

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
  - @java.lang.Deprecated public static final java.lang.String ALL_DATA_SOURCES
    
    deprecated:
    Use ConnectionSource#DEFAULT#DEFAULT instead
  - @java.lang.Deprecated public static final java.lang.String DEFAULT_DATA_SOURCE
    
    deprecated:
    Use ConnectionSource#ALL#ALL instead
  - protected java.util.Map<java.lang.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
  - java.util.List<java.lang.String> datasources
    
    Get the datasource names that this domain class works with.
    Returns:
    the datasource names
  - java.lang.Object defaultSort
    
    Returns:
    The default sort order definition, could be a string or a map
  - java.lang.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(T mapping, @groovy.lang.DelegatesTo(value: Entity) groovy.lang.Closure config)
    
    Configures an existing Mapping instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - Entity connection(java.lang.String name)
    
    Sets the datastore to use @return
    Parameters:
    name
  - Entity connections(java.lang.String[] names)
    
    Sets the connection to use @return
    Parameters:
    name
  - Entity connections(java.util.List<java.lang.String> names)
    
    Sets the connection to use @return
    Parameters:
    name
  - Entity datasource(java.lang.String name)
    
    Sets the datastore to use @return
    Parameters:
    name
  - protected P getOrInitializePropertyConfig(java.lang.String name)
  - P getPropertyConfig(java.lang.String name)
    
    Get a property config @return
    Parameters:
    name - The name of the property
  - java.util.Map<java.lang.String, P> getPropertyConfigs()
    
    Returns:
    The property configurations
  - java.lang.Object getSort()
  - Entity<P> id(java.util.Map identityConfig)
    
    Define the identity config
    Parameters:
    identityConfig - The id config
    Returns:
    This mapping
  - Entity<P> id(@groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure identityConfig)
    
    Define the identity config
    Parameters:
    identityConfig - The id config
    Returns:
    This mapping
  - boolean isVersioned()
    
    Returns:
    Whether this entity is versioned
  - @groovy.transform.CompileDynamic java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)
  - protected P newProperty()
  - Entity property(java.lang.String name, @groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure propertyConfig)
    
    Configure a property
    Parameters:
    name - The name of the property
    propertyConfig - The property config
    Returns:
    This mapping
  - Entity property(java.lang.String name, java.util.Map propertyConfig)
    
    Configure a property
    Parameters:
    name - The name of the property
    propertyConfig - The property config
    Returns:
    This mapping
  - P property(@groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure propertyConfig)
    
    Configure a new property
    Parameters:
    name - The name of the property
    propertyConfig - The property config
    Returns:
    This mapping
  - P property(java.util.Map propertyConfig)
    
    Configure a new property
    Parameters:
    name - The name of the property
    propertyConfig - The property config
    Returns:
    This mapping
  - java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)
  - Entity setSort(java.lang.Object defaultSort)
  - Entity tenantId(java.lang.String tenantIdProperty)
    
    Sets the tenant id
    Parameters:
    tenantIdProperty - The tenant id property
  - Entity version(@groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure versionConfig)
    
    Configures the name of the version column { version 'foo' }
    Parameters:
    isVersioned - True if a version property should be configured
  Entity version(java.util.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

@java.lang.Deprecated public static final java.lang.String ALL_DATA_SOURCES

@java.lang.Deprecated public static final java.lang.String DEFAULT_DATA_SOURCE

protected java.util.Map<java.lang.String, P> propertyConfigs

Property Detail

boolean autoTimestamp

boolean autowire

java.util.List<java.lang.String> datasources

java.lang.Object defaultSort

java.lang.Object sort

boolean stateless

boolean version

Constructor Detail

Entity()

Method Detail

protected P cloneGlobalConstraint()

<T extends Entity> static T configureExisting(T mapping, @groovy.lang.DelegatesTo(value: Entity) groovy.lang.Closure config)

Entity connection(java.lang.String name)

Entity connections(java.lang.String[] names)

Entity connections(java.util.List<java.lang.String> names)

Entity datasource(java.lang.String name)

protected P getOrInitializePropertyConfig(java.lang.String name)

P getPropertyConfig(java.lang.String name)

java.util.Map<java.lang.String, P> getPropertyConfigs()

java.lang.Object getSort()

Entity<P> id(java.util.Map identityConfig)

Entity<P> id(@groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure identityConfig)

boolean isVersioned()

@groovy.transform.CompileDynamic java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)

protected P newProperty()

Entity property(java.lang.String name, @groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure propertyConfig)

Entity property(java.lang.String name, java.util.Map propertyConfig)

P property(@groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure propertyConfig)

P property(java.util.Map propertyConfig)

java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)

Entity setSort(java.lang.Object defaultSort)

Entity tenantId(java.lang.String tenantIdProperty)

Entity version(@groovy.lang.DelegatesTo(value: Property) groovy.lang.Closure versionConfig)

Entity version(java.util.Map versionConfig)