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

Modifier and Type	Method and Description
Collection<TypeInformation<?>>	getManagedTypes() Returns the TypeInformations for all PersistentEntitys in 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(InvalidPersistentPropertyPath invalidPath) Returns the PersistentPropertyPath for the resolvable part of the given InvalidPersistentPropertyPath.
PersistentPropertyPath<P>	getPersistentPropertyPath(PropertyPath propertyPath) Returns all PersistentPropertys for the given path expression based on the given PropertyPath.
PersistentPropertyPath<P>	getPersistentPropertyPath(String propertyPath, Class<?> type) Returns all PersistentPropertys for the given dot path notation based on the given type.
boolean	hasPersistentEntityFor(Class<?> type) Returns whether the MappingContext currently contains a PersistentEntity for the type.

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. Will return null for types that are considered simple ones.

Parameters:

type - must not be null.

Returns:

See Also:

SimpleTypeHolder.isSimpleType(Class)

hasPersistentEntityFor

boolean hasPersistentEntityFor(Class<?> type)

Returns whether the MappingContext currently contains a PersistentEntity for the type.

Parameters:

type - can be null.

Returns:

Since:

1.8

getPersistentEntity

E getPersistentEntity(TypeInformation<?> type)

Returns a PersistentEntity for the given TypeInformation. Will return null for types that are considered simple ones.

Parameters:

type - must not be null.

Returns:

See Also:

SimpleTypeHolder.isSimpleType(Class)

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 (the type of the property is considered simple see SimpleTypeHolder.isSimpleType(Class)).

getPersistentPropertyPath

PersistentPropertyPath<P> getPersistentPropertyPath(PropertyPath propertyPath)

Returns all PersistentPropertys for the given path expression based on the given PropertyPath.

Parameters:

propertyPath - must not be null.

Returns:

the PersistentPropertyPath representing the given PropertyPath.

Throws:

InvalidPersistentPropertyPath - in case not all of the segments of the given PropertyPath can be resolved.

getPersistentPropertyPath

PersistentPropertyPath<P> getPersistentPropertyPath(String propertyPath,
                                                    Class<?> type)

Returns all PersistentPropertys for the given dot path notation based on the given type.

Parameters:

propertyPath - must not be null.

type - must not be null.

Returns:

the PersistentPropertyPath representing the given property path on the given type.

Throws:

InvalidPersistentPropertyPath - in case not all of the segments of the given property path can be resolved.

getPersistentPropertyPath

PersistentPropertyPath<P> getPersistentPropertyPath(InvalidPersistentPropertyPath invalidPath)

Returns the PersistentPropertyPath for the resolvable part of the given InvalidPersistentPropertyPath.

Parameters:

invalidPath - must not be null.

Returns:

the PersistentPropertyPath for the resolvable part of the given InvalidPersistentPropertyPath.

Since:

1.11

getManagedTypes

Collection<TypeInformation<?>> getManagedTypes()

Returns the TypeInformations for all PersistentEntitys in the MappingContext.

Returns:

all TypeInformations for the PersistentEntitys in the MappingContext.

Since:

1.8