Spring Data Commons

org.springframework.data.mapping.context
Interface MappingContext<E extends PersistentEntity<?,P>,P extends PersistentProperty<P>>

All Known Implementing Classes:
AbstractMappingContext

public interface MappingContext<E extends PersistentEntity<?,P>,P extends PersistentProperty<P>>

This interface defines the overall context including all known PersistentEntity instances and methods to obtain instances on demand. it is used internally to establish associations between entities and also at runtime to obtain entities by name.

Author:
Oliver Gierke, Jon Brisbin, Graeme Rocher

Method Summary
 List<Validator> getEntityValidators(E entity)
          Obtains a validator for the given entity TODO: Why do we need validators at the MappingContext?
 Collection<E> getPersistentEntities()
          Returns all PersistentEntitys held in the context.
 E getPersistentEntity(Class<?> type)
          Returns a PersistentEntity for the given Class.
 E getPersistentEntity(P persistentProperty)
          Returns the PersistentEntity mapped by the given PersistentProperty.
 E getPersistentEntity(TypeInformation<?> type)
          Returns a PersistentEntity for the given TypeInformation.
 PersistentPropertyPath<P> getPersistentPropertyPath(PropertyPath propertyPath)
          Returns all PersistentPropertys for the given path expression based on the given PropertyPath.
 

Method Detail

getPersistentEntities

Collection<E> getPersistentEntities()
Returns all PersistentEntitys held in the context.

Returns:

getPersistentEntity

E getPersistentEntity(Class<?> type)
Returns a PersistentEntity for the given Class.

Parameters:
type -
Returns:

getPersistentEntity

E getPersistentEntity(TypeInformation<?> type)
Returns a PersistentEntity for the given TypeInformation.

Parameters:
type -
Returns:

getPersistentEntity

E getPersistentEntity(P persistentProperty)
Returns the PersistentEntity mapped by the given PersistentProperty.

Parameters:
persistentProperty -
Returns:
the PersistentEntity mapped by the given PersistentProperty or null if no PersistentEntity exists for it or the PersistentProperty does not refer to an entity.

getPersistentPropertyPath

PersistentPropertyPath<P> getPersistentPropertyPath(PropertyPath propertyPath)
Returns all PersistentPropertys for the given path expression based on the given PropertyPath.

Type Parameters:
T -
Parameters:
type -
path -
Returns:

getEntityValidators

List<Validator> getEntityValidators(E entity)
Obtains a validator for the given entity TODO: Why do we need validators at the MappingContext?

Parameters:
entity - The entity
Returns:
A validator or null if none exists for the given entity

Spring Data Commons

Copyright © 2012. All Rights Reserved.