Mapping (GORM for Hibernate 5

org.grails.orm.hibernate.cfg.Mapping

Models the mapping from GORM classes to the db.
Authors:
Graeme Rocher
Since:
1.0

Inherited fields
Fields inherited from class	Fields
`class Entity`	`ALL_DATA_SOURCES, DEFAULT_DATA_SOURCE, propertyConfigs`

Properties Summary

Properties
Type	Name and description
`boolean`	`autoImport` Sets whether packaged domain classes should be auto-imported in HQL queries
`java.lang.Integer`	`batchSize` The batch size to use for lazy loading
`CacheConfig`	`cache` Caching config
`java.util.Map<java.lang.String, PropertyConfig>`	`columns` The configuration for each property
`java.lang.String`	`comment` DDL comment.
`DiscriminatorConfig`	`discriminator` Value used to discriminate entities in table-per-hierarchy inheritance mapping
`boolean`	`dynamicInsert` Whether to use dynamically created insert queries, at the cost of some performance
`boolean`	`dynamicUpdate` Whether to use dynamically created update queries, at the cost of some performance
`Property`	`identity` The identity definition
`SortConfig`	`sort` Used to hold the names and directions of the default property to sort by
`Table`	`table` The table
`boolean`	`tablePerConcreteClass` Sets whether to use table-per-concrete-class or table-per-subclass mapping
`boolean`	`tablePerHierarchy` Sets whether to use table-per-hierarchy or table-per-subclass mapping
`java.util.Map`	`userTypes` Custom hibernate user types
`boolean`	`versioned` Whether the class is versioned for optimistic locking

Methods Summary

Methods
Type	Name and description
`Mapping`	`cache(groovy.lang.Closure cacheConfig)` Define the cache config
`Mapping`	`cache(java.util.Map cacheConfig)` Define the cache config
`Mapping`	`cache(java.lang.String usage)` Define the cache config
`protected PropertyConfig`	`cloneGlobalConstraint()`
`CompositeIdentity`	`composite(java.lang.String... propertyNames)` Define a new composite id
`static Mapping`	`configureExisting(Mapping mapping, java.util.Map config)` Configures an existing Mapping instance
`static Mapping`	`configureExisting(Mapping mapping, groovy.lang.Closure config)` Configures an existing Mapping instance
`static Mapping`	`configureNew(groovy.lang.Closure config)` Configures a new Mapping instance
`Mapping`	`discriminator(groovy.lang.Closure discriminatorDef)` Configures the discriminator
`Mapping`	`discriminator(java.lang.String value)` Configures the discriminator
`Mapping`	`discriminator(java.util.Map args)` Configures the discriminator
`protected PropertyConfig`	`getOrInitializePropertyConfig(java.lang.String name)`
`PropertyConfig`	`getPropertyConfig(java.lang.String name)` Obtains a PropertyConfig object for the given name
`java.util.Map<java.lang.String, PropertyConfig>`	`getPropertyConfigs()`
`java.lang.String`	`getTableName()` The table name
`java.lang.String`	`getTypeName(java.lang.Class theClass)` Return a type name of the known custom user types
`Mapping`	`id(java.util.Map identityConfig)` Define the identity config
`Mapping`	`id(groovy.lang.Closure identityConfig)` Define the identity config
`Mapping`	`id(CompositeIdentity compositeIdentity)` Define the identity config
`boolean`	`isTablePerConcreteClass()`
`java.lang.Object`	`methodMissing(java.lang.String name, java.lang.Object args)`
`Mapping`	`property(java.lang.String name, groovy.lang.Closure propertyConfig)` Configure a property
`Mapping`	`property(java.lang.String name, java.util.Map propertyConfig)` Configure a property
`PropertyConfig`	`property(groovy.lang.Closure propertyConfig)` Configure a new property
`PropertyConfig`	`property(java.util.Map propertyConfig)` Configure a new property
`java.lang.Object`	`propertyMissing(java.lang.String name, java.lang.Object val)`
`void`	`setTableName(java.lang.String name)` Set the table name
`void`	`setTablePerConcreteClass(boolean tablePerConcreteClass)`
`Mapping`	`sort(java.lang.String name, java.lang.String direction)` Configures sorting
`Mapping`	`sort(java.util.Map nameAndDirections)` Configures sorting
`Mapping`	`table(java.lang.String name)` Define the table name
`Mapping`	`table(groovy.lang.Closure tableConfig)` Define the table config
`Mapping`	`table(java.util.Map tableConfig)` Define the table config
`Mapping`	`version(boolean isVersioned)`
`Mapping`	`version(java.util.Map versionConfig)`
`Mapping`	`version(java.lang.String versionColumn)`
`Entity`	`version(groovy.lang.Closure versionConfig)` Configure the version

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Entity`	`cloneGlobalConstraint, configureExisting, connection, connections, connections, datasource, getOrInitializePropertyConfig, getPropertyConfig, getPropertyConfigs, getSort, id, id, isVersioned, methodMissing, newProperty, property, property, property, property, propertyMissing, setSort, tenantId, version, version`
`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()`

- Property Detail
  - boolean autoImport
    
    Sets whether packaged domain classes should be auto-imported in HQL queries
  - java.lang.Integer batchSize
    
    The batch size to use for lazy loading
  - CacheConfig cache
    
    Caching config
  - java.util.Map<java.lang.String, PropertyConfig> columns
    
    The configuration for each property
  - java.lang.String comment
    
    DDL comment.
  - DiscriminatorConfig discriminator
    
    Value used to discriminate entities in table-per-hierarchy inheritance mapping
  - boolean dynamicInsert
    
    Whether to use dynamically created insert queries, at the cost of some performance
  - boolean dynamicUpdate
    
    Whether to use dynamically created update queries, at the cost of some performance
  - Property identity
    
    The identity definition
  - SortConfig sort
    
    Used to hold the names and directions of the default property to sort by
  - Table table
    
    The table
  - boolean tablePerConcreteClass
    
    Sets whether to use table-per-concrete-class or table-per-subclass mapping
  - boolean tablePerHierarchy
    
    Sets whether to use table-per-hierarchy or table-per-subclass mapping
  - java.util.Map userTypes
    
    Custom hibernate user types
  - boolean versioned
    
    Whether the class is versioned for optimistic locking
- Method Detail
  - Mapping cache(@groovy.lang.DelegatesTo(CacheConfig) groovy.lang.Closure cacheConfig)
    
    Define the cache config
    Returns:
    This mapping
    Parameters:
    cacheConfig - The cache config
  - Mapping cache(java.util.Map cacheConfig)
    
    Define the cache config
    Returns:
    This mapping
    Parameters:
    cacheConfig - The cache config
  - Mapping cache(java.lang.String usage)
    
    Define the cache config
    Returns:
    This mapping
    Parameters:
    cacheConfig - The cache config
  - @java.lang.Override protected PropertyConfig cloneGlobalConstraint()
  - CompositeIdentity composite(java.lang.String... propertyNames)
    
    Define a new composite id
    Returns:
    Parameters:
    propertyNames
  - static Mapping configureExisting(Mapping mapping, java.util.Map config)
    
    Configures an existing Mapping instance
    Returns:
    The new instance
    Parameters:
    config - The configuration
  - static Mapping configureExisting(Mapping mapping, @groovy.lang.DelegatesTo(Mapping) groovy.lang.Closure config)
    
    Configures an existing Mapping instance
    Returns:
    The new instance
    Parameters:
    config - The configuration
  - static Mapping configureNew(@groovy.lang.DelegatesTo(Mapping) groovy.lang.Closure config)
    
    Configures a new Mapping instance
    Returns:
    The new instance
    Parameters:
    config - The configuration
  - Mapping discriminator(@groovy.lang.DelegatesTo(DiscriminatorConfig) groovy.lang.Closure discriminatorDef)
    
    Configures the discriminator
    Returns:
    This mapping
    Parameters:
    discriminatorDef - The discriminator
  - Mapping discriminator(java.lang.String value)
    
    Configures the discriminator
    Returns:
    This mapping
    Parameters:
    the - discriminator value
  - Mapping discriminator(java.util.Map args)
    
    Configures the discriminator
    Returns:
    This mapping
    Parameters:
    discriminatorDef - The discriminator
  - @java.lang.Override protected PropertyConfig getOrInitializePropertyConfig(java.lang.String name)
  - @java.lang.Override PropertyConfig getPropertyConfig(java.lang.String name)
    
    Obtains a PropertyConfig object for the given name
  - @java.lang.Override java.util.Map<java.lang.String, PropertyConfig> getPropertyConfigs()
  - java.lang.String getTableName()
    
    The table name
  - java.lang.String getTypeName(java.lang.Class theClass)
    
    Return a type name of the known custom user types
  - @java.lang.Override Mapping id(java.util.Map identityConfig)
    
    Define the identity config
    Returns:
    This mapping
    Parameters:
    identityConfig - The id config
  - @java.lang.Override Mapping id(@groovy.lang.DelegatesTo(Identity) groovy.lang.Closure identityConfig)
    
    Define the identity config
    Returns:
    This mapping
    Parameters:
    identityConfig - The id config
  - Mapping id(CompositeIdentity compositeIdentity)
    
    Define the identity config
    Returns:
    This mapping
    Parameters:
    identityConfig - The id config
  - boolean isTablePerConcreteClass()
  - @groovy.transform.CompileDynamic @java.lang.Override java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)
  - @java.lang.Override Mapping property(java.lang.String name, @groovy.lang.DelegatesTo(PropertyConfig) groovy.lang.Closure propertyConfig)
    
    Configure a property
    Returns:
    This mapping
    Parameters:
    name - The name of the property
    propertyConfig - The property config
  - @java.lang.Override Mapping property(java.lang.String name, java.util.Map propertyConfig)
    
    Configure a property
    Returns:
    This mapping
    Parameters:
    name - The name of the property
    propertyConfig - The property config
  - @java.lang.Override PropertyConfig property(@groovy.lang.DelegatesTo(PropertyConfig) groovy.lang.Closure propertyConfig)
    
    Configure a new property
    Returns:
    This mapping
    Parameters:
    name - The name of the property
    propertyConfig - The property config
  - @java.lang.Override PropertyConfig property(java.util.Map propertyConfig)
    
    Configure a new property
    Returns:
    This mapping
    Parameters:
    name - The name of the property
    propertyConfig - The property config
  - @java.lang.Override java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)
  - void setTableName(java.lang.String name)
    
    Set the table name
  - void setTablePerConcreteClass(boolean tablePerConcreteClass)
  - Mapping sort(java.lang.String name, java.lang.String direction)
    
    Configures sorting
    Returns:
    This mapping
    Parameters:
    name - The name
    direction - The direction
  - Mapping sort(java.util.Map nameAndDirections)
    
    Configures sorting
    Returns:
    This mapping
    Parameters:
    name - The name
    direction - The direction
  - Mapping table(java.lang.String name)
    
    Define the table name
    Returns:
    This mapping
    Parameters:
    name - The table name
  - Mapping table(@groovy.lang.DelegatesTo(Table) groovy.lang.Closure tableConfig)
    
    Define the table config
    Returns:
    This mapping
    Parameters:
    tableConfig - The table config
  - Mapping table(java.util.Map tableConfig)
    
    Define the table config
    Returns:
    This mapping
    Parameters:
    tableConfig - The table config
  - @groovy.transform.CompileStatic Mapping version(boolean isVersioned)
    
    Configures whether to use versioning for optimistic locking { version false }
    Parameters:
    isVersioned - True if a version property should be configured
  @groovy.transform.CompileStatic @java.lang.Override Mapping version(java.util.Map versionConfig) Configures the name of the version column { version 'foo' } Parameters: isVersioned - True if a version property should be configured @groovy.transform.CompileStatic Mapping version(java.lang.String versionColumn) Configures the name of the version column { version 'foo' } Parameters: isVersioned - True if a version property should be configured @java.lang.Override Entity version(@groovy.lang.DelegatesTo(PropertyConfig) groovy.lang.Closure versionConfig) Configure the version Returns: This entity Parameters: versionConfig - The version config






    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    



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

[Groovy] Class Mapping

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

boolean autoImport

java.lang.Integer batchSize

CacheConfig cache

java.util.Map<java.lang.String, PropertyConfig> columns

java.lang.String comment

DiscriminatorConfig discriminator

boolean dynamicInsert

boolean dynamicUpdate

Property identity

SortConfig sort

Table table

boolean tablePerConcreteClass

boolean tablePerHierarchy

java.util.Map userTypes

boolean versioned

Method Detail

Mapping cache(@groovy.lang.DelegatesTo(CacheConfig) groovy.lang.Closure cacheConfig)

Mapping cache(java.util.Map cacheConfig)

Mapping cache(java.lang.String usage)

@java.lang.Override protected PropertyConfig cloneGlobalConstraint()

CompositeIdentity composite(java.lang.String... propertyNames)

static Mapping configureExisting(Mapping mapping, java.util.Map config)

static Mapping configureExisting(Mapping mapping, @groovy.lang.DelegatesTo(Mapping) groovy.lang.Closure config)

static Mapping configureNew(@groovy.lang.DelegatesTo(Mapping) groovy.lang.Closure config)

Mapping discriminator(@groovy.lang.DelegatesTo(DiscriminatorConfig) groovy.lang.Closure discriminatorDef)

Mapping discriminator(java.lang.String value)

Mapping discriminator(java.util.Map args)

@java.lang.Override protected PropertyConfig getOrInitializePropertyConfig(java.lang.String name)

@java.lang.Override PropertyConfig getPropertyConfig(java.lang.String name)

@java.lang.Override java.util.Map<java.lang.String, PropertyConfig> getPropertyConfigs()

java.lang.String getTableName()

java.lang.String getTypeName(java.lang.Class theClass)

@java.lang.Override Mapping id(java.util.Map identityConfig)

@java.lang.Override Mapping id(@groovy.lang.DelegatesTo(Identity) groovy.lang.Closure identityConfig)

Mapping id(CompositeIdentity compositeIdentity)

boolean isTablePerConcreteClass()

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

@java.lang.Override Mapping property(java.lang.String name, @groovy.lang.DelegatesTo(PropertyConfig) groovy.lang.Closure propertyConfig)

@java.lang.Override Mapping property(java.lang.String name, java.util.Map propertyConfig)

@java.lang.Override PropertyConfig property(@groovy.lang.DelegatesTo(PropertyConfig) groovy.lang.Closure propertyConfig)

@java.lang.Override PropertyConfig property(java.util.Map propertyConfig)

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

void setTableName(java.lang.String name)

void setTablePerConcreteClass(boolean tablePerConcreteClass)

Mapping sort(java.lang.String name, java.lang.String direction)

Mapping sort(java.util.Map nameAndDirections)

Mapping table(java.lang.String name)

Mapping table(@groovy.lang.DelegatesTo(Table) groovy.lang.Closure tableConfig)

Mapping table(java.util.Map tableConfig)

@groovy.transform.CompileStatic Mapping version(boolean isVersioned)

@groovy.transform.CompileStatic @java.lang.Override Mapping version(java.util.Map versionConfig)

@groovy.transform.CompileStatic Mapping version(java.lang.String versionColumn)

@java.lang.Override Entity version(@groovy.lang.DelegatesTo(PropertyConfig) groovy.lang.Closure versionConfig)