Identity (GORM for MongoDB

org.grails.orm.hibernate.cfg.Identity

```
@groovy.transform.CompileStatic
@groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: )
class Identity
extends org.grails.datastore.mapping.config.Property
```
Defines the identity generation strategy. In the case of a 'composite' identity the properties array defines the property names that formulate the composite id.
Authors:
Graeme Rocher
Since:
1.0

Inherited fields
Fields inherited from class	Fields
`class org.grails.datastore.mapping.config.Property`	`__$stMC`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`column` The column to map to
`java.lang.String`	`generator` The generator to use
`java.lang.String`	`name` The name of the id property
`NaturalId`	`natural` The natural id definition
`java.util.Map`	`params` Any parameters (for example for the generator)
`java.lang.Class`	`type` The type

Constructor Summary

Constructors
Constructor and description
`Identity()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Identity`	`configureExisting(Identity property, java.util.Map config)` Configures an existing Identity instance
	`static Identity`	`configureExisting(Identity property, groovy.lang.Closure config)` Configures an existing PropertyConfig instance
	`static Identity`	`configureNew(groovy.lang.Closure config)` Configures a new Identity instance
	`Identity`	`naturalId(groovy.lang.Closure naturalIdDef)` Define the natural id
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.grails.datastore.mapping.config.Property`	org.grails.datastore.mapping.config.Property#$getLookup(), org.grails.datastore.mapping.config.Property#accessType(jakarta.persistence.AccessType), org.grails.datastore.mapping.config.Property#cascade(java.lang.String), org.grails.datastore.mapping.config.Property#cascadeValidate(java.lang.String), org.grails.datastore.mapping.config.Property#cascades(java.util.List), org.grails.datastore.mapping.config.Property#clone(), org.grails.datastore.mapping.config.Property#clone(), org.grails.datastore.mapping.config.Property#configureExisting(org.grails.datastore.mapping.config.Property, groovy.lang.Closure), org.grails.datastore.mapping.config.Property#configureExisting(org.grails.datastore.mapping.config.Property, java.util.Map), org.grails.datastore.mapping.config.Property#derived(boolean), org.grails.datastore.mapping.config.Property#equals(java.lang.Object), org.grails.datastore.mapping.config.Property#fetch(jakarta.persistence.FetchType), org.grails.datastore.mapping.config.Property#fetch(java.lang.String), org.grails.datastore.mapping.config.Property#fetchStrategy(jakarta.persistence.FetchType), org.grails.datastore.mapping.config.Property#formula(java.lang.String), org.grails.datastore.mapping.config.Property#generator(java.lang.String), org.grails.datastore.mapping.config.Property#getAccessType(), org.grails.datastore.mapping.config.Property#getCascade(), org.grails.datastore.mapping.config.Property#getCascadeValidate(), org.grails.datastore.mapping.config.Property#getCascades(), org.grails.datastore.mapping.config.Property#getClass(), org.grails.datastore.mapping.config.Property#getDerived(), org.grails.datastore.mapping.config.Property#getEnumType(), org.grails.datastore.mapping.config.Property#getEnumTypeObject(), org.grails.datastore.mapping.config.Property#getFetchStrategy(), org.grails.datastore.mapping.config.Property#getFormula(), org.grails.datastore.mapping.config.Property#getGenerator(), org.grails.datastore.mapping.config.Property#getInList(), org.grails.datastore.mapping.config.Property#getIndex(), org.grails.datastore.mapping.config.Property#getLazy(), org.grails.datastore.mapping.config.Property#getMax(), org.grails.datastore.mapping.config.Property#getMaxSize(), org.grails.datastore.mapping.config.Property#getMetaClass(), org.grails.datastore.mapping.config.Property#getMin(), org.grails.datastore.mapping.config.Property#getMinSize(), org.grails.datastore.mapping.config.Property#getName(), org.grails.datastore.mapping.config.Property#getNullable(), org.grails.datastore.mapping.config.Property#getOrphanRemoval(), org.grails.datastore.mapping.config.Property#getProperty(java.lang.String), org.grails.datastore.mapping.config.Property#getReference(), org.grails.datastore.mapping.config.Property#getScale(), org.grails.datastore.mapping.config.Property#getTargetName(), org.grails.datastore.mapping.config.Property#getUniquenessGroup(), org.grails.datastore.mapping.config.Property#hashCode(), org.grails.datastore.mapping.config.Property#inList(java.util.List), org.grails.datastore.mapping.config.Property#index(boolean), org.grails.datastore.mapping.config.Property#invokeMethod(java.lang.String, java.lang.Object), org.grails.datastore.mapping.config.Property#isDerived(), org.grails.datastore.mapping.config.Property#isIndex(), org.grails.datastore.mapping.config.Property#isLazy(), org.grails.datastore.mapping.config.Property#isNullable(), org.grails.datastore.mapping.config.Property#isOrphanRemoval(), org.grails.datastore.mapping.config.Property#isReference(), org.grails.datastore.mapping.config.Property#isUnique(), org.grails.datastore.mapping.config.Property#isUniqueWithinGroup(), org.grails.datastore.mapping.config.Property#lazy(java.lang.Boolean), org.grails.datastore.mapping.config.Property#max(java.lang.Comparable), org.grails.datastore.mapping.config.Property#maxSize(java.lang.Number), org.grails.datastore.mapping.config.Property#min(java.lang.Comparable), org.grails.datastore.mapping.config.Property#minSize(java.lang.Number), org.grails.datastore.mapping.config.Property#name(java.lang.String), org.grails.datastore.mapping.config.Property#notify(), org.grails.datastore.mapping.config.Property#notifyAll(), org.grails.datastore.mapping.config.Property#nullable(boolean), org.grails.datastore.mapping.config.Property#orphanRemoval(boolean), org.grails.datastore.mapping.config.Property#reference(boolean), org.grails.datastore.mapping.config.Property#scale(int), org.grails.datastore.mapping.config.Property#setAccessType(jakarta.persistence.AccessType), org.grails.datastore.mapping.config.Property#setCascade(java.lang.String), org.grails.datastore.mapping.config.Property#setCascadeValidate(java.lang.String), org.grails.datastore.mapping.config.Property#setCascades(java.util.List), org.grails.datastore.mapping.config.Property#setDerived(boolean), org.grails.datastore.mapping.config.Property#setEnumType(jakarta.persistence.EnumType), org.grails.datastore.mapping.config.Property#setEnumType(java.lang.String), org.grails.datastore.mapping.config.Property#setFetch(java.lang.String), org.grails.datastore.mapping.config.Property#setFetchStrategy(jakarta.persistence.FetchType), org.grails.datastore.mapping.config.Property#setFormula(java.lang.String), org.grails.datastore.mapping.config.Property#setGenerator(java.lang.String), org.grails.datastore.mapping.config.Property#setInList(java.util.List), org.grails.datastore.mapping.config.Property#setIndex(boolean), org.grails.datastore.mapping.config.Property#setLazy(java.lang.Boolean), org.grails.datastore.mapping.config.Property#setMax(java.lang.Comparable), org.grails.datastore.mapping.config.Property#setMaxSize(java.lang.Number), org.grails.datastore.mapping.config.Property#setMetaClass(groovy.lang.MetaClass), org.grails.datastore.mapping.config.Property#setMin(java.lang.Comparable), org.grails.datastore.mapping.config.Property#setMinSize(java.lang.Number), org.grails.datastore.mapping.config.Property#setName(java.lang.String), org.grails.datastore.mapping.config.Property#setNullable(boolean), org.grails.datastore.mapping.config.Property#setOrphanRemoval(boolean), org.grails.datastore.mapping.config.Property#setProperty(java.lang.String, java.lang.Object), org.grails.datastore.mapping.config.Property#setRange(groovy.lang.ObjectRange), org.grails.datastore.mapping.config.Property#setReference(boolean), org.grails.datastore.mapping.config.Property#setScale(int), org.grails.datastore.mapping.config.Property#setSize(groovy.lang.IntRange), org.grails.datastore.mapping.config.Property#setTargetName(java.lang.String), org.grails.datastore.mapping.config.Property#setUnique(boolean), org.grails.datastore.mapping.config.Property#setUnique(java.lang.String), org.grails.datastore.mapping.config.Property#setUnique(java.util.List), org.grails.datastore.mapping.config.Property#super$1$clone(), org.grails.datastore.mapping.config.Property#targetName(java.lang.String), org.grails.datastore.mapping.config.Property#toString(), org.grails.datastore.mapping.config.Property#unique(boolean), org.grails.datastore.mapping.config.Property#unique(java.lang.String), org.grails.datastore.mapping.config.Property#unique(java.util.List), org.grails.datastore.mapping.config.Property#wait(), org.grails.datastore.mapping.config.Property#wait(long), org.grails.datastore.mapping.config.Property#wait(long, int)

- Property Detail
  - java.lang.String column
    
    The column to map to
  - java.lang.String generator
    
    The generator to use
  - java.lang.String name
    
    The name of the id property
  - NaturalId natural
    
    The natural id definition
  - java.util.Map params
    
    Any parameters (for example for the generator)
  - java.lang.Class type
    
    The type
- Constructor Detail
  - Identity()
- Method Detail
  - static Identity configureExisting(Identity property, java.util.Map config)
    
    Configures an existing Identity instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - static Identity configureExisting(Identity property, @groovy.lang.DelegatesTo(value: Identity)
    groovy.lang.Closure config)
    
    Configures an existing PropertyConfig instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - static Identity configureNew(@groovy.lang.DelegatesTo(value: Identity)
    groovy.lang.Closure config)
    
    Configures a new Identity instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - Identity naturalId(@groovy.lang.DelegatesTo(value: NaturalId)
    groovy.lang.Closure naturalIdDef)
    
    Define the natural id
    Parameters:
    naturalIdDef - The callable
    Returns:
    This id
  - java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Identity

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String column

java.lang.String generator

java.lang.String name

NaturalId natural

java.util.Map params

java.lang.Class type

Constructor Detail

Identity()

Method Detail

static Identity configureExisting(Identity property, java.util.Map config)

static Identity configureExisting(Identity property, @groovy.lang.DelegatesTo(value: Identity)
groovy.lang.Closure config)

static Identity configureNew(@groovy.lang.DelegatesTo(value: Identity)
groovy.lang.Closure config)

Identity naturalId(@groovy.lang.DelegatesTo(value: NaturalId)
groovy.lang.Closure naturalIdDef)

java.lang.String toString()

[Groovy] Class Identity

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String column

java.lang.String generator

java.lang.String name

NaturalId natural

java.util.Map params

java.lang.Class type

Constructor Detail

Identity()

Method Detail

static Identity configureExisting(Identity property, java.util.Map config)

static Identity configureExisting(Identity property, @groovy.lang.DelegatesTo(value: Identity)groovy.lang.Closure config)

static Identity configureNew(@groovy.lang.DelegatesTo(value: Identity)groovy.lang.Closure config)

Identity naturalId(@groovy.lang.DelegatesTo(value: NaturalId)groovy.lang.Closure naturalIdDef)

java.lang.String toString()

static Identity configureExisting(Identity property, @groovy.lang.DelegatesTo(value: Identity)
groovy.lang.Closure config)

static Identity configureNew(@groovy.lang.DelegatesTo(value: Identity)
groovy.lang.Closure config)

Identity naturalId(@groovy.lang.DelegatesTo(value: NaturalId)
groovy.lang.Closure naturalIdDef)