GormMappingConfigurationStrategy (GORM for Hibernate 5

org.grails.datastore.mapping.model.config.GormMappingConfigurationStrategy

All Implemented Interfaces and Traits:: MappingConfigurationStrategy

@java.lang.SuppressWarnings({"rawtypes", "unchecked"})
public class GormMappingConfigurationStrategy
extends java.lang.Object
implements MappingConfigurationStrategy

This implementation of the MappingConfigurationStrategy interface will interpret GORM-style syntax for defining entities and associations.

Example in Groovy code:

  
      class Author {
          String name
          static hasMany = [books:Book]
      }
      class Book {
         String title
         static belongsTo = [author:Author]
        }

Authors:: Graeme Rocher

Since:: 1.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`MAPPED_BY_NONE`
`protected MappingFactory`	`propertyFactory`

Constructor Summary

Constructors
Constructor and description
`GormMappingConfigurationStrategy(MappingFactory propertyFactory)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`configureOwningSide(Association association)`
	`protected Association`	`establishRelationshipForCollection(java.beans.PropertyDescriptor property, PersistentEntity entity, MappingContext context, java.util.Map<java.lang.String, java.lang.Class> hasManyMap, java.util.Map mappedByMap, boolean embedded)`
	`protected java.util.Map`	`getAllAssociationMap(ClassPropertyFetcher cpf)` Retrieves the association map
	`public java.util.Map`	`getAssociationMap(ClassPropertyFetcher cpf)` Retrieves the association map
	`public PersistentProperty[]`	`getCompositeIdentity(java.lang.Class javaClass, MappingContext context)`
	`public IdentityMapping`	`getDefaultIdentityMapping(ClassMapping classMapping)`
	`public PersistentProperty`	`getIdentity(java.lang.Class javaClass, MappingContext context)` See Also: MappingConfigurationStrategy.getIdentity
	`public IdentityMapping`	`getIdentityMapping(ClassMapping classMapping)` Obtains the identity mapping for the specified class mapping
	`protected PersistentEntity`	`getOrCreateAssociatedEntity(PersistentEntity entity, MappingContext context, java.lang.Class propType)` Tries to obtain or create an associated entity.
	`protected PersistentEntity`	`getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, java.lang.Class type)` Tries to obtain or create an embedded entity.
	`public java.util.Set`	`getOwningEntities(java.lang.Class javaClass, MappingContext context)`
	`public java.util.List<PersistentProperty>`	`getPersistentProperties(java.lang.Class javaClass, MappingContext context)`
	`public java.util.List<PersistentProperty>`	`getPersistentProperties(java.lang.Class javaClass, MappingContext context, ClassMapping classMapping)`
	`public java.util.List<PersistentProperty>`	`getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)`
	`public java.util.List<PersistentProperty>`	`getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)`
	`public static boolean`	`isAbstract(PersistentEntity entity)`
	`protected boolean`	`isCollectionType(java.lang.Class type)`
	`protected boolean`	`isExcludedProperty(java.lang.String propertyName, ClassMapping classMapping, java.util.Collection transients, boolean includeIdentifiers)`
	`public boolean`	`isPersistentEntity(java.lang.Class clazz)` Tests whether an class is a persistent entity
	`public void`	`setCanExpandMappingContext(boolean canExpandMappingContext)` Whether the strategy can add new entities to the mapping context
	`protected boolean`	`supportsCustomType(java.lang.Class<?> propertyType)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), 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
  - public static final java.lang.String MAPPED_BY_NONE
  - protected MappingFactory propertyFactory
- Constructor Detail
  - public GormMappingConfigurationStrategy(MappingFactory propertyFactory)
- Method Detail
  - protected void configureOwningSide(Association association)
  - protected Association establishRelationshipForCollection(java.beans.PropertyDescriptor property, PersistentEntity entity, MappingContext context, java.util.Map<java.lang.String, java.lang.Class> hasManyMap, java.util.Map mappedByMap, boolean embedded)
  - protected java.util.Map getAllAssociationMap(ClassPropertyFetcher cpf)
    
    Retrieves the association map
    Parameters:
    cpf - The ClassPropertyFetcher instance
    Returns:
    The association map
  - public java.util.Map getAssociationMap(ClassPropertyFetcher cpf)
    
    Retrieves the association map
    Parameters:
    cpf - The ClassPropertyFetcher instance
    Returns:
    The association map
  - @java.lang.Override
    public PersistentProperty[] getCompositeIdentity(java.lang.Class javaClass, MappingContext context)
  - public IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)
  - public PersistentProperty getIdentity(java.lang.Class javaClass, MappingContext context)
    
    See Also:
    MappingConfigurationStrategy.getIdentity
  - public IdentityMapping getIdentityMapping(ClassMapping classMapping)
    
    Obtains the identity mapping for the specified class mapping
    Parameters:
    classMapping - The class mapping
    Returns:
    The identity mapping
  - protected PersistentEntity getOrCreateAssociatedEntity(PersistentEntity entity, MappingContext context, java.lang.Class propType)
    
    Tries to obtain or create an associated entity. Note that if #canExpandMappingContext is set to false then this method may return null
    Parameters:
    entity - The main entity
    context - The context
    propType - The associated property type
    Returns:
    The associated entity or null
  - protected PersistentEntity getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, java.lang.Class type)
    
    Tries to obtain or create an embedded entity. Note that if #canExpandMappingContext is set to false then this method may return null
    Parameters:
    entity - The main entity
    context - The context
    type - The associated property type
    Returns:
    The associated entity or null
  - public java.util.Set getOwningEntities(java.lang.Class javaClass, MappingContext context)
  - public java.util.List<PersistentProperty> getPersistentProperties(java.lang.Class javaClass, MappingContext context)
  - public java.util.List<PersistentProperty> getPersistentProperties(java.lang.Class javaClass, MappingContext context, ClassMapping classMapping)
  - @java.lang.Override
    public java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)
  - public java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)
  - public static boolean isAbstract(PersistentEntity entity)
  - protected boolean isCollectionType(java.lang.Class type)
  - protected boolean isExcludedProperty(java.lang.String propertyName, ClassMapping classMapping, java.util.Collection transients, boolean includeIdentifiers)
  - public boolean isPersistentEntity(java.lang.Class clazz)
    
    Tests whether an class is a persistent entity Based on the same method in Grails core within the DomainClassArtefactHandler class
    Parameters:
    clazz - The java class
    Returns:
    True if it is a persistent entity
  - public void setCanExpandMappingContext(boolean canExpandMappingContext)
    
    Whether the strategy can add new entities to the mapping context
  - protected boolean supportsCustomType(java.lang.Class<?> propertyType)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class GormMappingConfigurationStrategy

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String MAPPED_BY_NONE

protected MappingFactory propertyFactory

Constructor Detail

public GormMappingConfigurationStrategy(MappingFactory propertyFactory)

Method Detail

protected void configureOwningSide(Association association)

protected Association establishRelationshipForCollection(java.beans.PropertyDescriptor property, PersistentEntity entity, MappingContext context, java.util.Map<java.lang.String, java.lang.Class> hasManyMap, java.util.Map mappedByMap, boolean embedded)

protected java.util.Map getAllAssociationMap(ClassPropertyFetcher cpf)

public java.util.Map getAssociationMap(ClassPropertyFetcher cpf)

@java.lang.Override
public PersistentProperty[] getCompositeIdentity(java.lang.Class javaClass, MappingContext context)

public IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)

public PersistentProperty getIdentity(java.lang.Class javaClass, MappingContext context)

public IdentityMapping getIdentityMapping(ClassMapping classMapping)

protected PersistentEntity getOrCreateAssociatedEntity(PersistentEntity entity, MappingContext context, java.lang.Class propType)

protected PersistentEntity getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, java.lang.Class type)

public java.util.Set getOwningEntities(java.lang.Class javaClass, MappingContext context)

public java.util.List<PersistentProperty> getPersistentProperties(java.lang.Class javaClass, MappingContext context)

public java.util.List<PersistentProperty> getPersistentProperties(java.lang.Class javaClass, MappingContext context, ClassMapping classMapping)

@java.lang.Override
public java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)

public java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)

public static boolean isAbstract(PersistentEntity entity)

protected boolean isCollectionType(java.lang.Class type)

protected boolean isExcludedProperty(java.lang.String propertyName, ClassMapping classMapping, java.util.Collection transients, boolean includeIdentifiers)

public boolean isPersistentEntity(java.lang.Class clazz)

public void setCanExpandMappingContext(boolean canExpandMappingContext)

protected boolean supportsCustomType(java.lang.Class<?> propertyType)

[Java] Class GormMappingConfigurationStrategy

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String MAPPED_BY_NONE

protected MappingFactory propertyFactory

Constructor Detail

public GormMappingConfigurationStrategy(MappingFactory propertyFactory)

Method Detail

protected void configureOwningSide(Association association)

protected Association establishRelationshipForCollection(java.beans.PropertyDescriptor property, PersistentEntity entity, MappingContext context, java.util.Map<java.lang.String, java.lang.Class> hasManyMap, java.util.Map mappedByMap, boolean embedded)

protected java.util.Map getAllAssociationMap(ClassPropertyFetcher cpf)

public java.util.Map getAssociationMap(ClassPropertyFetcher cpf)

@java.lang.Overridepublic PersistentProperty[] getCompositeIdentity(java.lang.Class javaClass, MappingContext context)

public IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)

public PersistentProperty getIdentity(java.lang.Class javaClass, MappingContext context)

public IdentityMapping getIdentityMapping(ClassMapping classMapping)

protected PersistentEntity getOrCreateAssociatedEntity(PersistentEntity entity, MappingContext context, java.lang.Class propType)

protected PersistentEntity getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, java.lang.Class type)

public java.util.Set getOwningEntities(java.lang.Class javaClass, MappingContext context)

public java.util.List<PersistentProperty> getPersistentProperties(java.lang.Class javaClass, MappingContext context)

public java.util.List<PersistentProperty> getPersistentProperties(java.lang.Class javaClass, MappingContext context, ClassMapping classMapping)

@java.lang.Overridepublic java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)

public java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)

public static boolean isAbstract(PersistentEntity entity)

protected boolean isCollectionType(java.lang.Class type)

protected boolean isExcludedProperty(java.lang.String propertyName, ClassMapping classMapping, java.util.Collection transients, boolean includeIdentifiers)

public boolean isPersistentEntity(java.lang.Class clazz)

public void setCanExpandMappingContext(boolean canExpandMappingContext)

protected boolean supportsCustomType(java.lang.Class<?> propertyType)

@java.lang.Override
public PersistentProperty[] getCompositeIdentity(java.lang.Class javaClass, MappingContext context)

@java.lang.Override
public java.util.List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)