org.eclipse.persistence.jpa
Class PersistenceProvider

java.lang.Object
  org.eclipse.persistence.jpa.PersistenceProvider

All Implemented Interfaces:

PersistenceProvider, ProviderUtil

Direct Known Subclasses:

PersistenceProvider

public class PersistenceProvider
extends java.lang.Object
implements PersistenceProvider, ProviderUtil

This is the EclipseLink EJB 3.0 provider This provider should be used by JavaEE and JavaSE users.

Field Summary

protected org.eclipse.persistence.internal.jpa.deployment.PersistenceInitializationHelper

initializationHelper

Constructor Summary

PersistenceProvider()

Method Summary

EntityManagerFactory	createContainerEntityManagerFactory(PersistenceUnitInfo info, java.util.Map properties) Called by the container when an EntityManagerFactory is to be created.
EntityManagerFactory	createEntityManagerFactory(java.lang.String emName, java.util.Map properties) Called by Persistence class when an EntityManagerFactory is to be created.
protected EntityManagerFactory	createEntityManagerFactory(java.lang.String emName, java.util.Map properties, java.lang.ClassLoader classLoader) Called by Persistence class when an EntityManagerFactory is to be created.
ProviderUtil	getProviderUtil() Return the utility interface implemented by the persistence provider.
LoadState	isLoaded(java.lang.Object entity) If the provider determines that the entity has been provided by itself and that the state of all attributes for which FetchType.EAGER has been specified have been loaded, this method returns LoadState.LOADED.
LoadState	isLoadedWithoutReference(java.lang.Object entity, java.lang.String attributeName) If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED.
LoadState	isLoadedWithReference(java.lang.Object entity, java.lang.String attributeName) If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

initializationHelper

protected org.eclipse.persistence.internal.jpa.deployment.PersistenceInitializationHelper initializationHelper

Constructor Detail

PersistenceProvider

public PersistenceProvider()

Method Detail

createEntityManagerFactory

public EntityManagerFactory createEntityManagerFactory(java.lang.String emName,
                                                       java.util.Map properties)

Called by Persistence class when an EntityManagerFactory is to be created.

Specified by:

createEntityManagerFactory in interface PersistenceProvider

Parameters:

emName - The name of the persistence unit

map - A Map of properties for use by the persistence provider. These properties may be used to override the values of the corresponding elements in the persistence.xml file or specify values for properties not specified in the persistence.xml.

Returns:

EntityManagerFactory for the persistence unit, or null if the provider is not the right provider

createEntityManagerFactory

protected EntityManagerFactory createEntityManagerFactory(java.lang.String emName,
                                                          java.util.Map properties,
                                                          java.lang.ClassLoader classLoader)

Called by Persistence class when an EntityManagerFactory is to be created.

Parameters:

emName - The name of the persistence unit

map - A Map of properties for use by the persistence provider. These properties may be used to override the values of the corresponding elements in the persistence.xml file or specify values for properties not specified in the persistence.xml.

classLoader - The classloader to search for persistence units on

Returns:

EntityManagerFactory for the persistence unit, or null if the provider is not the right provider

createContainerEntityManagerFactory

public EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info,
                                                                java.util.Map properties)

Called by the container when an EntityManagerFactory is to be created.

Specified by:

createContainerEntityManagerFactory in interface PersistenceProvider

Parameters:

info - Metadata for use by the persistence provider

map - A Map of integration-level properties for use by the persistence provider.

Returns:

EntityManagerFactory for the persistence unit specified by the metadata

getProviderUtil

public ProviderUtil getProviderUtil()

Return the utility interface implemented by the persistence provider.

Specified by:

getProviderUtil in interface PersistenceProvider

Returns:

ProviderUtil interface

Since:

Java Persistence 2.0

isLoadedWithoutReference

public LoadState isLoadedWithoutReference(java.lang.Object entity,
                                          java.lang.String attributeName)

If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED. If the provider determines that the entity has been provided by itself and that either entity attributes with FetchType.EAGER have not been loaded or that the state of the specified attribute has not been loaded, this methods returns LoadState.NOT_LOADED. If a provider cannot determine the load state, this method returns LoadState.UNKNOWN. The provider's implementation of this method must not obtain a reference to an attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.

Specified by:

isLoadedWithoutReference in interface ProviderUtil

Parameters:

entity -

attributeName - name of attribute whose load status is to be determined

Returns:

load status of the attribute

isLoadedWithReference

public LoadState isLoadedWithReference(java.lang.Object entity,
                                       java.lang.String attributeName)

If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED. If a provider determines that the entity has been provided by itself and that either the entity attributes with FetchType.EAGER have not been loaded or that the state of the specified attribute has not been loaded, this method returns return LoadState.NOT_LOADED. If the provider cannot determine the load state, this method returns LoadState.UNKNOWN. The provider's implementation of this method is permitted to obtain a reference to the attribute value. (This access is safe because providers which might trigger the loading of the attribute state will have already been determined by isLoadedWithoutReference. )

Specified by:

isLoadedWithReference in interface ProviderUtil

Parameters:

entity -

attributeName - name of attribute whose load status is to be determined

Returns:

load status of the attribute

isLoaded

public LoadState isLoaded(java.lang.Object entity)

If the provider determines that the entity has been provided by itself and that the state of all attributes for which FetchType.EAGER has been specified have been loaded, this method returns LoadState.LOADED. If the provider determines that the entity has been provided by itself and that not all attributes with FetchType.EAGER have been loaded, this method returns LoadState.NOT_LOADED. If the provider cannot determine if the entity has been provided by itself, this method returns LoadState.UNKNOWN. The provider's implementation of this method must not obtain a reference to any attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.

Specified by:

isLoaded in interface ProviderUtil

Parameters:

entity - whose loaded status is to be determined

Returns:

load status of the entity