org.eclipse.persistence.jpa

Class PersistenceProvider

java.lang.Object

org.eclipse.persistence.jpa.PersistenceProvider

All Implemented Interfaces:

javax.persistence.spi.PersistenceProvider, javax.persistence.spi.ProviderUtil

Direct Known Subclasses:

PersistenceProvider

public class PersistenceProvider
extends Object
implements javax.persistence.spi.PersistenceProvider, javax.persistence.spi.ProviderUtil

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

Constructor Summary

Constructors

Constructor and Description
PersistenceProvider()

Method Summary

Methods

Modifier and Type	Method and Description
javax.persistence.EntityManagerFactory	createContainerEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo info, Map properties) Called by the container when an EntityManagerFactory is to be created.
javax.persistence.EntityManagerFactory	createEntityManagerFactory(String emName, Map properties) Called by Persistence class when an EntityManagerFactory is to be created.
javax.persistence.spi.ProviderUtil	getProviderUtil() Return the utility interface implemented by the persistence provider.
javax.persistence.spi.LoadState	isLoaded(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.
javax.persistence.spi.LoadState	isLoadedWithoutReference(Object entity, 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.
javax.persistence.spi.LoadState	isLoadedWithReference(Object entity, 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

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

Constructor Detail

PersistenceProvider

public PersistenceProvider()

Method Detail

createEntityManagerFactory

public javax.persistence.EntityManagerFactory createEntityManagerFactory(String emName,
                                                                Map properties)

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

Specified by:

createEntityManagerFactory in interface javax.persistence.spi.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

createContainerEntityManagerFactory

public javax.persistence.EntityManagerFactory createContainerEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo info,
                                                                         Map properties)

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

Specified by:

createContainerEntityManagerFactory in interface javax.persistence.spi.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 javax.persistence.spi.ProviderUtil getProviderUtil()

Return the utility interface implemented by the persistence provider.

Specified by:

getProviderUtil in interface javax.persistence.spi.PersistenceProvider

Returns:

ProviderUtil interface

Since:

Java Persistence 2.0

isLoadedWithoutReference

public javax.persistence.spi.LoadState isLoadedWithoutReference(Object entity,
                                                       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 javax.persistence.spi.ProviderUtil

Parameters:

entity -

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

Returns:

load status of the attribute

isLoadedWithReference

public javax.persistence.spi.LoadState isLoadedWithReference(Object entity,
                                                    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 javax.persistence.spi.ProviderUtil

Parameters:

entity -

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

Returns:

load status of the attribute

isLoaded

public javax.persistence.spi.LoadState isLoaded(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 javax.persistence.spi.ProviderUtil

Parameters:

entity - whose loaded status is to be determined

Returns:

load status of the entity