GormMappingConfigurationStrategy (Grace Data

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

All Implemented Interfaces and Traits:: MappingConfigurationStrategy

@SuppressWarnings({ "rawtypes", "unchecked" })
public class GormMappingConfigurationStrategy
extends 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 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(PropertyDescriptor property, PersistentEntity entity, MappingContext context, Map<String, Class> hasManyMap, Map mappedByMap, boolean embedded)`
	`protected Map`	`getAllAssociationMap(ClassPropertyFetcher cpf)` Retrieves the association map
	`public Map`	`getAssociationMap(ClassPropertyFetcher cpf)` Retrieves the association map
	`public PersistentProperty[]`	`getCompositeIdentity(Class javaClass, MappingContext context)`
	`public IdentityMapping`	`getDefaultIdentityMapping(ClassMapping classMapping)`
	`public PersistentProperty`	`getIdentity(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, Class propType)` Tries to obtain or create an associated entity.
	`protected PersistentEntity`	`getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, Class type)` Tries to obtain or create an embedded entity.
	`public Set`	`getOwningEntities(Class javaClass, MappingContext context)`
	`public List<PersistentProperty>`	`getPersistentProperties(Class javaClass, MappingContext context)`
	`public List<PersistentProperty>`	`getPersistentProperties(Class javaClass, MappingContext context, ClassMapping classMapping)`
	`public List<PersistentProperty>`	`getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)`
	`public List<PersistentProperty>`	`getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)`
	`public static boolean`	`isAbstract(PersistentEntity entity)`
	`protected boolean`	`isCollectionType(Class type)`
	`protected boolean`	`isExcludedProperty(String propertyName, ClassMapping classMapping, Collection transients, boolean includeIdentifiers)`
	`public boolean`	`isPersistentEntity(Class clazz)` Tests whether a class is a persistent entity
	`public void`	`setCanExpandMappingContext(boolean canExpandMappingContext)` Whether the strategy can add new entities to the mapping context
	`protected boolean`	`supportsCustomType(Class<?> propertyType)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final String MAPPED_BY_NONE
  - protected MappingFactory propertyFactory
- Constructor Detail
  - public GormMappingConfigurationStrategy(MappingFactory propertyFactory)
- Method Detail
  - protected void configureOwningSide(Association association)
  - protected Association establishRelationshipForCollection(PropertyDescriptor property, PersistentEntity entity, MappingContext context, Map<String, Class> hasManyMap, Map mappedByMap, boolean embedded)
  - protected Map getAllAssociationMap(ClassPropertyFetcher cpf)
    
    Retrieves the association map
    Parameters:
    cpf - The ClassPropertyFetcher instance
    Returns:
    The association map
  - public Map getAssociationMap(ClassPropertyFetcher cpf)
    
    Retrieves the association map
    Parameters:
    cpf - The ClassPropertyFetcher instance
    Returns:
    The association map
  - @Override
    public PersistentProperty[] getCompositeIdentity(Class javaClass, MappingContext context)
  - @Override
    public IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)
  - @Override
    public PersistentProperty getIdentity(Class javaClass, MappingContext context)
    
    See Also:
    MappingConfigurationStrategy.getIdentity
  - @Override
    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, 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, 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
  - @Override
    public Set getOwningEntities(Class javaClass, MappingContext context)
  - @Override
    public List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context)
  - @Override
    public List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context, ClassMapping classMapping)
  - @Override
    public List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping, boolean includeIdentifiers)
  - @Override
    public List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)
  - public static boolean isAbstract(PersistentEntity entity)
  - protected boolean isCollectionType(Class type)
  - protected boolean isExcludedProperty(String propertyName, ClassMapping classMapping, Collection transients, boolean includeIdentifiers)
  - @Override
    public boolean isPersistentEntity(Class clazz)
    
    Tests whether a 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
  - @Override
    public void setCanExpandMappingContext(boolean canExpandMappingContext)
    
    Whether the strategy can add new entities to the mapping context
  - protected boolean supportsCustomType(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 String MAPPED_BY_NONE

protected MappingFactory propertyFactory

Constructor Detail

public GormMappingConfigurationStrategy(MappingFactory propertyFactory)

Method Detail

protected void configureOwningSide(Association association)

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

protected Map getAllAssociationMap(ClassPropertyFetcher cpf)

public Map getAssociationMap(ClassPropertyFetcher cpf)

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

@Override
public IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)

@Override
public PersistentProperty getIdentity(Class javaClass, MappingContext context)

@Override
public IdentityMapping getIdentityMapping(ClassMapping classMapping)

protected PersistentEntity getOrCreateAssociatedEntity(PersistentEntity entity, MappingContext context, Class propType)

protected PersistentEntity getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, Class type)

@Override
public Set getOwningEntities(Class javaClass, MappingContext context)

@Override
public List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context)

@Override
public List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context, ClassMapping classMapping)

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

@Override
public List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)

public static boolean isAbstract(PersistentEntity entity)

protected boolean isCollectionType(Class type)

protected boolean isExcludedProperty(String propertyName, ClassMapping classMapping, Collection transients, boolean includeIdentifiers)

@Override
public boolean isPersistentEntity(Class clazz)

@Override
public void setCanExpandMappingContext(boolean canExpandMappingContext)

protected boolean supportsCustomType(Class<?> propertyType)

[Java] Class GormMappingConfigurationStrategy

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String MAPPED_BY_NONE

protected MappingFactory propertyFactory

Constructor Detail

public GormMappingConfigurationStrategy(MappingFactory propertyFactory)

Method Detail

protected void configureOwningSide(Association association)

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

protected Map getAllAssociationMap(ClassPropertyFetcher cpf)

public Map getAssociationMap(ClassPropertyFetcher cpf)

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

@Overridepublic IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)

@Overridepublic PersistentProperty getIdentity(Class javaClass, MappingContext context)

@Overridepublic IdentityMapping getIdentityMapping(ClassMapping classMapping)

protected PersistentEntity getOrCreateAssociatedEntity(PersistentEntity entity, MappingContext context, Class propType)

protected PersistentEntity getOrCreateEmbeddedEntity(PersistentEntity entity, MappingContext context, Class type)

@Overridepublic Set getOwningEntities(Class javaClass, MappingContext context)

@Overridepublic List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context)

@Overridepublic List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context, ClassMapping classMapping)

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

@Overridepublic List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)

public static boolean isAbstract(PersistentEntity entity)

protected boolean isCollectionType(Class type)

protected boolean isExcludedProperty(String propertyName, ClassMapping classMapping, Collection transients, boolean includeIdentifiers)

@Overridepublic boolean isPersistentEntity(Class clazz)

@Overridepublic void setCanExpandMappingContext(boolean canExpandMappingContext)

protected boolean supportsCustomType(Class<?> propertyType)

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

@Override
public IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)

@Override
public PersistentProperty getIdentity(Class javaClass, MappingContext context)

@Override
public IdentityMapping getIdentityMapping(ClassMapping classMapping)

@Override
public Set getOwningEntities(Class javaClass, MappingContext context)

@Override
public List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context)

@Override
public List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context, ClassMapping classMapping)

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

@Override
public List<PersistentProperty> getPersistentProperties(PersistentEntity entity, MappingContext context, ClassMapping classMapping)

@Override
public boolean isPersistentEntity(Class clazz)

@Override
public void setCanExpandMappingContext(boolean canExpandMappingContext)