HibernateMappingBuilder (GORM for Hibernate 5

org.grails.orm.hibernate.cfg.HibernateMappingBuilder

All Implemented Interfaces and Traits:

MappingConfigurationBuilder<Mapping, PropertyConfig>
```
class HibernateMappingBuilder
extends java.lang.Object
implements MappingConfigurationBuilder<Mapping, PropertyConfig>
```
Implements the ORM mapping DSL constructing a model that can be evaluated by the GrailsDomainBinder class which maps GORM classes onto the database.
Authors:
Graeme Rocher
Since:
1.0

Nested Class Summary

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

Properties Summary

Properties
Type	Name and description
`static org.slf4j.Logger`	`LOG`
`java.lang.String`	`className`
`groovy.lang.Closure`	`defaultConstraints`
`Mapping`	`mapping`

Constructor Summary

Constructors
Constructor and description
`HibernateMappingBuilder (java.lang.String className)` Constructor for builder
`HibernateMappingBuilder (Mapping mapping, java.lang.String className, groovy.lang.Closure defaultConstraints)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`autoImport(boolean b)`
	`void`	`autoTimestamp(boolean b)` Set whether auto time stamping should occur for last_updated and date_created columns
	`void`	`autowire(boolean autowire)`
	`void`	`batchSize(java.lang.Integer num)` Configures the batch-size used for lazy loading
	`void`	`cache(java.util.Map args)`
	`void`	`cache(java.lang.String usage)`
	`void`	`cache(java.lang.String usage, java.util.Map args)`
	`void`	`cache(boolean shouldCache)`
	`void`	`columns(groovy.lang.Closure callable)`
	`void`	`comment(java.lang.String comment)`
	`void`	`datasource(java.lang.String name)`
	`void`	`datasources(java.util.List<java.lang.String> names)`
	`void`	`discriminator(java.lang.String name)`
	`void`	`discriminator(java.util.Map args)`
	`void`	`dynamicInsert(boolean b)` Whether to use dynamic update queries
	`void`	`dynamicUpdate(boolean b)` Whether to use dynamic update queries
	`Mapping`	`evaluate(groovy.lang.Closure mappingClosure, java.lang.Object context)` Central entry point for the class.
	`java.util.Map<java.lang.String, PropertyConfig>`	`getProperties()`
	`void`	`hibernateCustomUserType(java.util.Map args)`
	`void`	`id(java.util.Map args)`
	`void`	`includes(groovy.lang.Closure callable)` Include another config in this one
	`void`	`methodMissing(java.lang.String name, java.lang.Object args)`
	`void`	`order(java.lang.String direction)`
	`void`	`sort(java.lang.String name)`
	`void`	`sort(java.util.Map namesAndDirections)`
	`void`	`table(java.lang.String name)`
	`void`	`table(java.util.Map tableDef)`
	`void`	`tablePerConcreteClass(boolean isTablePerConcreteClass)` If true the class and its subclasses will be mapped with table per subclass mapping
	`void`	`tablePerHierarchy(boolean isTablePerHierarchy)` If true the class and its sub classes will be mapped with table per hierarchy mapping
	`void`	`tablePerSubclass(boolean isTablePerSubClass)` If true the class and its subclasses will be mapped with table per subclass mapping
	`void`	`tenantId(java.lang.String tenantIdProperty)` Sets the tenant id
	`void`	`version(boolean isVersioned)`
	`void`	`version(java.lang.String versionColumn)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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
  - static final org.slf4j.Logger LOG
  - final java.lang.String className
  - final groovy.lang.Closure defaultConstraints
  - Mapping mapping
- Constructor Detail
  - HibernateMappingBuilder(java.lang.String className)
    
    Constructor for builder
    Parameters:
    className - The name of the class being mapped
  - HibernateMappingBuilder(Mapping mapping, java.lang.String className, groovy.lang.Closure defaultConstraints)
- Method Detail
  - @groovy.transform.CompileStatic void autoImport(boolean b)
    
    Configures whether to auto import packages domain classes in HQL queries. Default is true { autoImport false }
  @groovy.transform.CompileStatic void autoTimestamp(boolean b) Set whether auto time stamping should occur for last_updated and date_created columns void autowire(boolean autowire) @groovy.transform.CompileStatic void batchSize(java.lang.Integer num) Configures the batch-size used for lazy loading Parameters: num - The batch size to use @groovy.transform.CompileStatic void cache(java.util.Map args) Configures the second-level cache for the class { cache usage:'read-only', include:'all' } Parameters: args - Named arguments that contain the "usage" and/or "include" parameters @groovy.transform.CompileStatic void cache(java.lang.String usage) Configures the second-level cache for the class { cache 'read-only' } Parameters: usage - The usage type for the cache which is one of CacheConfig.USAGE_OPTIONS @groovy.transform.CompileStatic void cache(java.lang.String usage, java.util.Map args) Configures the second-level cache for the class { cache 'read-only', include:'all } Parameters: usage - The usage type for the cache which is one of CacheConfig.USAGE_OPTIONS @groovy.transform.CompileStatic void cache(boolean shouldCache) Configures the second-level cache with the default usage of 'read-write' and the default include of 'all' if the passed argument is true { cache true } Parameters: shouldCache - True if the default cache configuration should be applied @groovy.transform.CompileStatic void columns(groovy.lang.Closure callable) Consumes the columns closure and populates the value into the Mapping objects columns property Parameters: callable - The closure containing the column definitions @groovy.transform.CompileStatic void comment(java.lang.String comment) @groovy.transform.CompileStatic void datasource(java.lang.String name) @groovy.transform.CompileStatic void datasources(java.util.List<java.lang.String> names) @groovy.transform.CompileStatic void discriminator(java.lang.String name) Configures the discriminator name. Example: { discriminator 'foo' } Parameters: name - The name of the table @groovy.transform.CompileStatic void discriminator(java.util.Map args) Configures the discriminator name. Example: { discriminator value:'foo', column:'type' } Parameters: name - The name of the table @groovy.transform.CompileStatic void dynamicInsert(boolean b) Whether to use dynamic update queries @groovy.transform.CompileStatic void dynamicUpdate(boolean b) Whether to use dynamic update queries @java.lang.Override @groovy.transform.CompileStatic Mapping evaluate(groovy.lang.Closure mappingClosure, java.lang.Object context) Central entry point for the class. Passing a closure that defines a set of mappings will evaluate said mappings and populate the "mapping" property of this class which can then be obtained with getMappings() Parameters: mappingClosure - The closure that defines the ORM DSL @java.lang.Override java.util.Map<java.lang.String, PropertyConfig> getProperties() @groovy.transform.CompileStatic void hibernateCustomUserType(java.util.Map args) void id(java.util.Map args) Configures the identity strategy for the mapping. Examples { id generator:'sequence' } { id composite: ['one', 'two'] } Parameters: args - The named arguments to the id method @groovy.transform.CompileStatic void includes(groovy.lang.Closure callable) Include another config in this one void methodMissing(java.lang.String name, java.lang.Object args) void order(java.lang.String direction) Configures the default sort direction. Example: { order 'desc' } Parameters: name - The name of the property to sort by void sort(java.lang.String name) Configures the default sort column. Example: { sort 'foo' } Parameters: name - The name of the property to sort by void sort(java.util.Map namesAndDirections) Configures the default sort column. Example: { sort foo:'desc' } Parameters: namesAndDirections - The names and directions of the property to sort by @groovy.transform.CompileStatic void table(java.lang.String name) Configures the table name. Example: { table 'foo' } Parameters: name - The name of the table @groovy.transform.CompileStatic void table(java.util.Map tableDef) Configures the table name. Example: { table name:'foo', schema:'dbo', catalog:'CRM' } @groovy.transform.CompileStatic void tablePerConcreteClass(boolean isTablePerConcreteClass) If true the class and its subclasses will be mapped with table per subclass mapping @groovy.transform.CompileStatic void tablePerHierarchy(boolean isTablePerHierarchy) If true the class and its sub classes will be mapped with table per hierarchy mapping @groovy.transform.CompileStatic void tablePerSubclass(boolean isTablePerSubClass) If true the class and its subclasses will be mapped with table per subclass mapping void tenantId(java.lang.String tenantIdProperty) Sets the tenant id Parameters: tenantIdProperty - The tenant id property @groovy.transform.CompileStatic void 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 void version(java.lang.String versionColumn) 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 HibernateMappingBuilder

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final org.slf4j.Logger LOG

final java.lang.String className

final groovy.lang.Closure defaultConstraints

Mapping mapping

Constructor Detail

HibernateMappingBuilder(java.lang.String className)

HibernateMappingBuilder(Mapping mapping, java.lang.String className, groovy.lang.Closure defaultConstraints)

Method Detail

@groovy.transform.CompileStatic void autoImport(boolean b)

@groovy.transform.CompileStatic void autoTimestamp(boolean b)

void autowire(boolean autowire)

@groovy.transform.CompileStatic void batchSize(java.lang.Integer num)

@groovy.transform.CompileStatic void cache(java.util.Map args)

@groovy.transform.CompileStatic void cache(java.lang.String usage)

@groovy.transform.CompileStatic void cache(java.lang.String usage, java.util.Map args)

@groovy.transform.CompileStatic void cache(boolean shouldCache)

@groovy.transform.CompileStatic void columns(groovy.lang.Closure callable)

@groovy.transform.CompileStatic void comment(java.lang.String comment)

@groovy.transform.CompileStatic void datasource(java.lang.String name)

@groovy.transform.CompileStatic void datasources(java.util.List<java.lang.String> names)

@groovy.transform.CompileStatic void discriminator(java.lang.String name)

@groovy.transform.CompileStatic void discriminator(java.util.Map args)

@groovy.transform.CompileStatic void dynamicInsert(boolean b)

@groovy.transform.CompileStatic void dynamicUpdate(boolean b)

@java.lang.Override @groovy.transform.CompileStatic Mapping evaluate(groovy.lang.Closure mappingClosure, java.lang.Object context)

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

@groovy.transform.CompileStatic void hibernateCustomUserType(java.util.Map args)

void id(java.util.Map args)

@groovy.transform.CompileStatic void includes(groovy.lang.Closure callable)

void methodMissing(java.lang.String name, java.lang.Object args)

void order(java.lang.String direction)

void sort(java.lang.String name)

void sort(java.util.Map namesAndDirections)

@groovy.transform.CompileStatic void table(java.lang.String name)

@groovy.transform.CompileStatic void table(java.util.Map tableDef)

@groovy.transform.CompileStatic void tablePerConcreteClass(boolean isTablePerConcreteClass)

@groovy.transform.CompileStatic void tablePerHierarchy(boolean isTablePerHierarchy)

@groovy.transform.CompileStatic void tablePerSubclass(boolean isTablePerSubClass)

void tenantId(java.lang.String tenantIdProperty)

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

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