| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:09 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PersistenceProvider (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PersistenceProvider (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/jpa/JpaQuery.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/jpa/PersistenceProvider.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.jpa</div> |
| <h2 title="Class PersistenceProvider" class="title">Class PersistenceProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.jpa.PersistenceProvider</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>jakarta.persistence.spi.PersistenceProvider, jakarta.persistence.spi.ProviderUtil</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PersistenceProvider</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements jakarta.persistence.spi.PersistenceProvider, jakarta.persistence.spi.ProviderUtil</pre> |
| <div class="block">This is the EclipseLink EJB 3.0 provider |
| |
| This provider should be used by JavaEE and JavaSE users.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#PersistenceProvider--">PersistenceProvider</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#checkForProviderProperty-java.util.Map-">checkForProviderProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">Need to check that the provider property is null or set for EclipseLink</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>jakarta.persistence.EntityManagerFactory</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#createContainerEntityManagerFactory-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-">createContainerEntityManagerFactory</a></span>(jakarta.persistence.spi.PersistenceUnitInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">Called by the container when an EntityManagerFactory |
| is to be created.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected jakarta.persistence.EntityManagerFactory</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#createContainerEntityManagerFactoryImpl-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-boolean-">createContainerEntityManagerFactoryImpl</a></span>(jakarta.persistence.spi.PersistenceUnitInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties, |
| boolean requiresConnection)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>jakarta.persistence.EntityManagerFactory</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#createEntityManagerFactory-java.lang.String-java.util.Map-">createEntityManagerFactory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> emName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">Called by Persistence class when an EntityManagerFactory |
| is to be created.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#createEntityManagerFactoryImpl-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-boolean-">createEntityManagerFactoryImpl</a></span>(jakarta.persistence.spi.PersistenceUnitInfo puInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties, |
| boolean requiresConnection)</code> |
| <div class="block">Internal method to return the entity manager factory.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#generateSchema-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-">generateSchema</a></span>(jakarta.persistence.spi.PersistenceUnitInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">Create database schemas and/or tables and/or create DDL |
| scripts as determined by the supplied properties.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#generateSchema-java.lang.String-java.util.Map-">generateSchema</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> persistenceUnitName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">Create database schemas and/or tables and/or create DDL scripts as |
| determined by the supplied properties.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#getClassLoader-java.lang.String-java.util.Map-">getClassLoader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> emName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">Answer the classloader to use to create an EntityManager.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.jpa.deployment.JPAInitializer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#getInitializer-java.lang.String-java.util.Map-">getInitializer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> emName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> m)</code> |
| <div class="block">Return JPAInitializer corresponding to the passed classLoader.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>jakarta.persistence.spi.ProviderUtil</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#getProviderUtil--">getProviderUtil</a></span>()</code> |
| <div class="block">Return the utility interface implemented by the persistence |
| provider.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>jakarta.persistence.spi.LoadState</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#isLoaded-java.lang.Object-">isLoaded</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity)</code> |
| <div class="block">If the provider determines that the entity has been provided |
| by itself and that the state of all attributes for which |
| <code>FetchType.EAGER</code> has been specified have been loaded, this |
| method returns <code>LoadState.LOADED</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>jakarta.persistence.spi.LoadState</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#isLoadedWithoutReference-java.lang.Object-java.lang.String-">isLoadedWithoutReference</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attributeName)</code> |
| <div class="block">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 <code>LoadState.LOADED</code>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>jakarta.persistence.spi.LoadState</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/PersistenceProvider.html#isLoadedWithReference-java.lang.Object-java.lang.String-">isLoadedWithReference</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attributeName)</code> |
| <div class="block">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 <code>LoadState.LOADED</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PersistenceProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PersistenceProvider</h4> |
| <pre>public PersistenceProvider()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createEntityManagerFactoryImpl-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityManagerFactoryImpl</h4> |
| <pre>protected org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl createEntityManagerFactoryImpl(jakarta.persistence.spi.PersistenceUnitInfo puInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties, |
| boolean requiresConnection)</pre> |
| <div class="block">Internal method to return the entity manager factory.</div> |
| </li> |
| </ul> |
| <a name="createEntityManagerFactory-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityManagerFactory</h4> |
| <pre>public jakarta.persistence.EntityManagerFactory createEntityManagerFactory(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> emName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">Called by Persistence class when an EntityManagerFactory |
| is to be created.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>createEntityManagerFactory</code> in interface <code>jakarta.persistence.spi.PersistenceProvider</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>emName</code> - The name of the persistence unit</dd> |
| <dd><code>properties</code> - 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.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EntityManagerFactory for the persistence unit, |
| or null if the provider is not the right provider</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateSchema-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateSchema</h4> |
| <pre>public void generateSchema(jakarta.persistence.spi.PersistenceUnitInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">Create database schemas and/or tables and/or create DDL |
| scripts as determined by the supplied properties. |
| <p> |
| Called by the Persistence class when schema generation is to occur as a |
| separate phase from creation of the entity manager factory. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>generateSchema</code> in interface <code>jakarta.persistence.spi.PersistenceProvider</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - the name of the persistence unit</dd> |
| <dd><code>properties</code> - properties for schema generation; these may also |
| contain provider-specific properties. The value of these |
| properties override any values that may have been configured |
| elsewhere.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>jakarta.persistence.PersistenceException</code> - if insufficient or inconsistent |
| configuration information is provided of if schema generation |
| otherwise fails</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Java Persistence 2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateSchema-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateSchema</h4> |
| <pre>public boolean generateSchema(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> persistenceUnitName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">Create database schemas and/or tables and/or create DDL scripts as |
| determined by the supplied properties. |
| <p> |
| Called by the Persistence class when schema generation is to occur as a |
| separate phase from creation of the entity manager factory. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>generateSchema</code> in interface <code>jakarta.persistence.spi.PersistenceProvider</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistenceUnitName</code> - the name of the persistence unit</dd> |
| <dd><code>properties</code> - properties for schema generation; these may also |
| contain provider-specific properties. The value of these |
| properties override any values that may have been configured |
| elsewhere.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>jakarta.persistence.PersistenceException</code> - if insufficient or inconsistent |
| configuration information is provided of if schema generation |
| otherwise fails</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Java Persistence 2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitializer-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitializer</h4> |
| <pre>public org.eclipse.persistence.internal.jpa.deployment.JPAInitializer getInitializer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> emName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> m)</pre> |
| <div class="block">Return JPAInitializer corresponding to the passed classLoader. |
| Note: This is written as an instance method rather than a static to allow |
| it to be overridden</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>emName</code> - </dd> |
| <dd><code>m</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkForProviderProperty-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkForProviderProperty</h4> |
| <pre>public boolean checkForProviderProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">Need to check that the provider property is null or set for EclipseLink</div> |
| </li> |
| </ul> |
| <a name="createContainerEntityManagerFactory-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createContainerEntityManagerFactory</h4> |
| <pre>public jakarta.persistence.EntityManagerFactory createContainerEntityManagerFactory(jakarta.persistence.spi.PersistenceUnitInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">Called by the container when an EntityManagerFactory |
| is to be created.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>createContainerEntityManagerFactory</code> in interface <code>jakarta.persistence.spi.PersistenceProvider</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - Metadata for use by the persistence provider</dd> |
| <dd><code>properties</code> - A Map of integration-level properties for use |
| by the persistence provider.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EntityManagerFactory for the persistence unit |
| specified by the metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createContainerEntityManagerFactoryImpl-jakarta.persistence.spi.PersistenceUnitInfo-java.util.Map-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createContainerEntityManagerFactoryImpl</h4> |
| <pre>protected jakarta.persistence.EntityManagerFactory createContainerEntityManagerFactoryImpl(jakarta.persistence.spi.PersistenceUnitInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties, |
| boolean requiresConnection)</pre> |
| </li> |
| </ul> |
| <a name="getProviderUtil--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProviderUtil</h4> |
| <pre>public jakarta.persistence.spi.ProviderUtil getProviderUtil()</pre> |
| <div class="block">Return the utility interface implemented by the persistence |
| provider.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getProviderUtil</code> in interface <code>jakarta.persistence.spi.PersistenceProvider</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ProviderUtil interface</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Java Persistence 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLoadedWithoutReference-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoadedWithoutReference</h4> |
| <pre>public jakarta.persistence.spi.LoadState isLoadedWithoutReference(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attributeName)</pre> |
| <div class="block">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 <code>LoadState.LOADED</code>. |
| If the provider determines that the entity has been provided |
| by itself and that either entity attributes with <code>FetchType.EAGER</code> |
| have not been loaded or that the state of the specified |
| attribute has not been loaded, this methods returns |
| <code>LoadState.NOT_LOADED</code>. |
| If a provider cannot determine the load state, this method |
| returns <code>LoadState.UNKNOWN</code>. |
| 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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isLoadedWithoutReference</code> in interface <code>jakarta.persistence.spi.ProviderUtil</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - </dd> |
| <dd><code>attributeName</code> - name of attribute whose load status is |
| to be determined</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>load status of the attribute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLoadedWithReference-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoadedWithReference</h4> |
| <pre>public jakarta.persistence.spi.LoadState isLoadedWithReference(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> attributeName)</pre> |
| <div class="block">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 <code>LoadState.LOADED</code>. |
| If a provider determines that the entity has been provided |
| by itself and that either the entity attributes with <code>FetchType.EAGER</code> |
| have not been loaded or that the state of the specified |
| attribute has not been loaded, this method returns |
| return <code>LoadState.NOT_LOADED</code>. |
| If the provider cannot determine the load state, this method |
| returns <code>LoadState.UNKNOWN</code>. |
| 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 |
| <code>isLoadedWithoutReference</code>. )</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isLoadedWithReference</code> in interface <code>jakarta.persistence.spi.ProviderUtil</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - </dd> |
| <dd><code>attributeName</code> - name of attribute whose load status is |
| to be determined</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>load status of the attribute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLoaded-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoaded</h4> |
| <pre>public jakarta.persistence.spi.LoadState isLoaded(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> entity)</pre> |
| <div class="block">If the provider determines that the entity has been provided |
| by itself and that the state of all attributes for which |
| <code>FetchType.EAGER</code> has been specified have been loaded, this |
| method returns <code>LoadState.LOADED</code>. |
| If the provider determines that the entity has been provided |
| by itself and that not all attributes with <code>FetchType.EAGER</code> |
| have been loaded, this method returns <code>LoadState.NOT_LOADED</code>. |
| If the provider cannot determine if the entity has been |
| provided by itself, this method returns <code>LoadState.UNKNOWN</code>. |
| 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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isLoaded</code> in interface <code>jakarta.persistence.spi.ProviderUtil</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - whose loaded status is to be determined</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>load status of the entity</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClassLoader-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getClassLoader</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> getClassLoader(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> emName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">Answer the classloader to use to create an EntityManager. |
| If a classloader is not found in the properties map then |
| use the current thread classloader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ClassLoader</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/jpa/JpaQuery.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/jpa/PersistenceProvider.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
