org.kuali.rice.krad.data.jpa
Interface JpaMetadataProvider

All Superinterfaces:

MetadataProvider, Provider

All Known Implementing Classes:

EclipseLinkJpaMetadataProviderImpl, JpaMetadataProviderImpl

public interface JpaMetadataProvider
extends MetadataProvider

Subclass of the MetadataProvider which contains the additional methods needed.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

DataObjectRelationship

addExtensionRelationship(Class<?> entityClass, String extensionPropertyName, Class<?> extensionEntity) Given the parameters, injects into the JPA repository a 1:1 relationship between the parent entity and the extension entity via the given property name (which must exist on the entityClass).

Methods inherited from interface org.kuali.rice.krad.data.provider.MetadataProvider

getMetadataForType, getSupportedTypes, handles, provideMetadata, provideMetadataForTypes, requiresListOfExistingTypes

Method Detail

addExtensionRelationship

DataObjectRelationship addExtensionRelationship(Class<?> entityClass,
                                                String extensionPropertyName,
                                                Class<?> extensionEntity)

Given the parameters, injects into the JPA repository a 1:1 relationship between the parent entity and the extension entity via the given property name (which must exist on the entityClass).

Parameters:

entityClass - The parent (owning) class which must be already known to the JPA persistence unit. This one's metadata will be modified within the internals of the JPA metadata.

extensionPropertyName - The property on the parent class which will hold the extensionEntity. This property must be of the type of the extension entity or a superclass. (Object will work.)

extensionEntity - The child/extension class which needs to be linked. It must also already be known to JPA.

Returns:

A 1:1 relationship between the parent entry and the extension entity via the given property name.