org.springframework.datastore.mapping
Interface MappingConfigurationStrategy

All Known Implementing Classes:
GormMappingConfigurationStrategy

public interface MappingConfigurationStrategy

This interface defines a strategy for reading how persistent properties are defined in a persistent entity.

Subclasses can implement this interface in order to provide a different mechanism for mapping entities such as annotations or XML.

Since:
1.0

Method Summary
 IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)
          Obtains the default manner in which identifiers are mapped.
 PersistentProperty getIdentity(Class javaClass, MappingContext context)
          Obtains the identity of a persistent entity
 Set getOwningEntities(Class javaClass, MappingContext context)
          Returns a set of entities that "own" the given entity.
 List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context)
           
 List<PersistentProperty> getPersistentProperties(Class javaClass, MappingContext context, ClassMapping mapping)
          Obtains a List of PersistentProperty instances for the given Mapped class
 boolean isPersistentEntity(Class javaClass)
          Tests whether the given class is a persistent entity
 

Method Detail

isPersistentEntity

boolean isPersistentEntity(Class javaClass)
Tests whether the given class is a persistent entity

Parameters:
javaClass - The java class
Returns:
true if it is a persistent entity

getPersistentProperties

List<PersistentProperty> getPersistentProperties(Class javaClass,
                                                 MappingContext context)
See Also:
getPersistentProperties(Class, MappingContext, ClassMapping)

getPersistentProperties

List<PersistentProperty> getPersistentProperties(Class javaClass,
                                                 MappingContext context,
                                                 ClassMapping mapping)
Obtains a List of PersistentProperty instances for the given Mapped class

Parameters:
javaClass - The Java class
context - The MappingContext instance
mapping - The mapping for this class
Returns:
The PersistentProperty instances

getIdentity

PersistentProperty getIdentity(Class javaClass,
                               MappingContext context)
Obtains the identity of a persistent entity

Parameters:
javaClass - The Java class
context - The MappingContext
Returns:
A PersistentProperty instance

getDefaultIdentityMapping

IdentityMapping getDefaultIdentityMapping(ClassMapping classMapping)
Obtains the default manner in which identifiers are mapped. In GORM this is just using a property called 'id', but in other frameworks this may differ. For example JPA expects an annotated @Id property

Parameters:
classMapping - The ClassMapping instance
Returns:
The default identifier mapping

getOwningEntities

Set getOwningEntities(Class javaClass,
                      MappingContext context)
Returns a set of entities that "own" the given entity. Ownership dictates default cascade strategies. So if entity A owns entity B then saves, updates and deletes will cascade from A to B

Parameters:
javaClass - The Java class
context - The MappingContext
Returns:
A Set of owning classes