| <!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>JpaHelper (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="JpaHelper (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":41,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/jpa/JpaQuery.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/jpa/JpaHelper.html" target="_top">Frames</a></li> |
| <li><a href="JpaHelper.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 JpaHelper" class="title">Class JpaHelper</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.JpaHelper</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JpaHelper</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></pre> |
| <div class="block">This sample illustrates the JPA helper methods that may be of use |
| to EclipseLink customers attempting to leverage EclipseLink specific functionality.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>dclarke, gpelletie</dd> |
| </dl> |
| </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/JpaHelper.html#JpaHelper--">JpaHelper</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static jakarta.persistence.EntityManagerFactory</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#createEntityManagerFactory-org.eclipse.persistence.sessions.server.Server-">createEntityManagerFactory</a></span>(<a href="../../../../org/eclipse/persistence/sessions/server/Server.html" title="interface in org.eclipse.persistence.sessions.server">Server</a> session)</code> |
| <div class="block">Create a EclipseLink EMF given a ServerSession that has already been created |
| and logged in.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static jakarta.persistence.EntityManagerFactory</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#createEntityManagerFactory-java.lang.String-">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> sessionName)</code> |
| <div class="block">Create a EclipseLink EMF using a session name and sessions.xml.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static jakarta.persistence.Query</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#createQuery-org.eclipse.persistence.queries.DatabaseQuery-jakarta.persistence.EntityManager-">createQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query, |
| jakarta.persistence.EntityManager em)</code> |
| <div class="block">Create a EclipseLink JPA query dynamically given a EclipseLink query.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getDatabaseQuery-jakarta.persistence.Query-">getDatabaseQuery</a></span>(jakarta.persistence.Query query)</code> |
| <div class="block">Access the internal EclipseLink query wrapped within the JPA query.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/sessions/DatabaseSession.html" title="interface in org.eclipse.persistence.sessions">DatabaseSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getDatabaseSession-jakarta.persistence.EntityManagerFactory-">getDatabaseSession</a></span>(jakarta.persistence.EntityManagerFactory emf)</code> |
| <div class="block">Retrieve the shared database session from the EMF.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html" title="interface in org.eclipse.persistence.jpa">JpaEntityManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getEntityManager-jakarta.persistence.EntityManager-">getEntityManager</a></span>(jakarta.persistence.EntityManager entityManager)</code> |
| <div class="block">Convert a JPA entityManager into a EclipseLink specific one.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa">JpaEntityManagerFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getEntityManagerFactory-jakarta.persistence.EntityManager-">getEntityManagerFactory</a></span>(jakarta.persistence.EntityManager em)</code> |
| <div class="block">Given an EntityManager return the EntityManagerFactory that created it.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa">JpaEntityManagerFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getEntityManagerFactory-jakarta.persistence.EntityManagerFactory-">getEntityManagerFactory</a></span>(jakarta.persistence.EntityManagerFactory emf)</code> |
| <div class="block">Given a JPA EntityManagerFactory attempt to cast it to a EclipseLink EMF.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getEntityManagerFactory-org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl-">getEntityManagerFactory</a></span>(org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl emf)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html" title="class in org.eclipse.persistence.queries">ReadAllQuery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getReadAllQuery-jakarta.persistence.Query-">getReadAllQuery</a></span>(jakarta.persistence.Query query)</code> |
| <div class="block">Access the internal EclipseLink query wrapped within the JPA query.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/queries/ReportQuery.html" title="class in org.eclipse.persistence.queries">ReportQuery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getReportQuery-jakarta.persistence.Query-">getReportQuery</a></span>(jakarta.persistence.Query query)</code> |
| <div class="block">Access the internal EclipseLink query wrapped within the JPA query.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/sessions/server/Server.html" title="interface in org.eclipse.persistence.sessions.server">Server</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getServerSession-jakarta.persistence.EntityManagerFactory-">getServerSession</a></span>(jakarta.persistence.EntityManagerFactory emf)</code> |
| <div class="block">Retrieve the shared server session from the EMF.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/sessions/broker/SessionBroker.html" title="class in org.eclipse.persistence.sessions.broker">SessionBroker</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getSessionBroker-jakarta.persistence.EntityManagerFactory-">getSessionBroker</a></span>(jakarta.persistence.EntityManagerFactory emf)</code> |
| <div class="block">Retrieve the shared session broker from the EMF.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#isEclipseLink-jakarta.persistence.EntityManager-">isEclipseLink</a></span>(jakarta.persistence.EntityManager em)</code> |
| <div class="block">Verify if the JPA provider is EclipseLink.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#isEclipseLink-jakarta.persistence.EntityManagerFactory-">isEclipseLink</a></span>(jakarta.persistence.EntityManagerFactory emf)</code> |
| <div class="block">Verify if the JPA provider is EclipseLink</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#isEclipseLink-jakarta.persistence.Query-">isEclipseLink</a></span>(jakarta.persistence.Query query)</code> |
| <div class="block">Verify if the JPA provider is EclipseLink</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#isReportQuery-jakarta.persistence.Query-">isReportQuery</a></span>(jakarta.persistence.Query query)</code> |
| <div class="block">Determine if the JPA query is a EclipseLink ReportQuery.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#loadUnfetchedObject-org.eclipse.persistence.queries.FetchGroupTracker-">loadUnfetchedObject</a></span>(<a href="../../../../org/eclipse/persistence/queries/FetchGroupTracker.html" title="interface in org.eclipse.persistence.queries">FetchGroupTracker</a> entity)</code> |
| <div class="block">If the object has a fetch group then the whole object is read in.</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="JpaHelper--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JpaHelper</h4> |
| <pre>public JpaHelper()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isEclipseLink-jakarta.persistence.EntityManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEclipseLink</h4> |
| <pre>public static boolean isEclipseLink(jakarta.persistence.EntityManager em)</pre> |
| <div class="block">Verify if the JPA provider is EclipseLink. If you are in a container |
| and not in a transaction this method may incorrectly return false. |
| It is always more reliable to check isEclipseLink on the EMF or Query.</div> |
| </li> |
| </ul> |
| <a name="isEclipseLink-jakarta.persistence.EntityManagerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEclipseLink</h4> |
| <pre>public static boolean isEclipseLink(jakarta.persistence.EntityManagerFactory emf)</pre> |
| <div class="block">Verify if the JPA provider is EclipseLink</div> |
| </li> |
| </ul> |
| <a name="isEclipseLink-jakarta.persistence.Query-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEclipseLink</h4> |
| <pre>public static boolean isEclipseLink(jakarta.persistence.Query query)</pre> |
| <div class="block">Verify if the JPA provider is EclipseLink</div> |
| </li> |
| </ul> |
| <a name="isReportQuery-jakarta.persistence.Query-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReportQuery</h4> |
| <pre>public static boolean isReportQuery(jakarta.persistence.Query query)</pre> |
| <div class="block">Determine if the JPA query is a EclipseLink ReportQuery. Useful for |
| frameworks that want to determine which get_X_Query method they can |
| safely invoke.</div> |
| </li> |
| </ul> |
| <a name="getReportQuery-jakarta.persistence.Query-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReportQuery</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/queries/ReportQuery.html" title="class in org.eclipse.persistence.queries">ReportQuery</a> getReportQuery(jakarta.persistence.Query query)</pre> |
| <div class="block">Access the internal EclipseLink query wrapped within the JPA query. A |
| EclipseLink JPA created from JP QL contains a ReportQuery if multiple |
| items or a non-entity type is being returned. This method will fail |
| if a single entity type is being returned as the query is a ReadAllQuery.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/jpa/JpaHelper.html#getReadAllQuery-jakarta.persistence.Query-"><code>getReadAllQuery(jakarta.persistence.Query)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatabaseQuery-jakarta.persistence.Query-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatabaseQuery</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> getDatabaseQuery(jakarta.persistence.Query query)</pre> |
| <div class="block">Access the internal EclipseLink query wrapped within the JPA query.</div> |
| </li> |
| </ul> |
| <a name="getReadAllQuery-jakarta.persistence.Query-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadAllQuery</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html" title="class in org.eclipse.persistence.queries">ReadAllQuery</a> getReadAllQuery(jakarta.persistence.Query query)</pre> |
| <div class="block">Access the internal EclipseLink query wrapped within the JPA query. A EclipseLink |
| JPA created from JP QL only contains a ReadAllQuery if only a single entity |
| type is being returned. |
| |
| A ReadAllQuery is the super class of a ReportQuery so this method will |
| always work for either a ReportQuery or ReadAllQuery.</div> |
| </li> |
| </ul> |
| <a name="createQuery-org.eclipse.persistence.queries.DatabaseQuery-jakarta.persistence.EntityManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createQuery</h4> |
| <pre>public static jakarta.persistence.Query createQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query, |
| jakarta.persistence.EntityManager em)</pre> |
| <div class="block">Create a EclipseLink JPA query dynamically given a EclipseLink query.</div> |
| </li> |
| </ul> |
| <a name="getEntityManager-jakarta.persistence.EntityManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityManager</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html" title="interface in org.eclipse.persistence.jpa">JpaEntityManager</a> getEntityManager(jakarta.persistence.EntityManager entityManager)</pre> |
| <div class="block">Convert a JPA entityManager into a EclipseLink specific one. This will work |
| both within a JavaSE deployment as well as within a container where the |
| EntityManager may be wrapped. |
| |
| In the case where the container is not in a transaction it may return null |
| for its delegate. When this happens the only way to access an EntityManager |
| is to use the EntityManagerFactory to create a temporary one where the |
| application manage its lifecycle.</div> |
| </li> |
| </ul> |
| <a name="getEntityManagerFactory-org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityManagerFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public static org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl getEntityManagerFactory(org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl emf)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Given a JPA EntityManagerFactory attempt to cast it to a EclipseLink EMF. |
| |
| Although this method currently returns an instance of EntityManagerFactoryImpl, it |
| is recommended that users cast to JpaEntityManagerFactory. Future versions of EclipseLink will |
| return that interface from this method instead</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><code>JpaEntityManagerFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntityManagerFactory-jakarta.persistence.EntityManagerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityManagerFactory</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa">JpaEntityManagerFactory</a> getEntityManagerFactory(jakarta.persistence.EntityManagerFactory emf)</pre> |
| <div class="block">Given a JPA EntityManagerFactory attempt to cast it to a EclipseLink EMF.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><code>JpaEntityManagerFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntityManagerFactory-jakarta.persistence.EntityManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityManagerFactory</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa">JpaEntityManagerFactory</a> getEntityManagerFactory(jakarta.persistence.EntityManager em)</pre> |
| <div class="block">Given an EntityManager return the EntityManagerFactory that created it. This method must be called |
| on an open entity manager and will return null if called on a closed entityManager. |
| |
| This method will return null for non-EclipseLink EntityManagers.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><code>JpaEntityManagerFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatabaseSession-jakarta.persistence.EntityManagerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatabaseSession</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/sessions/DatabaseSession.html" title="interface in org.eclipse.persistence.sessions">DatabaseSession</a> getDatabaseSession(jakarta.persistence.EntityManagerFactory emf)</pre> |
| <div class="block">Retrieve the shared database session from the EMF.</div> |
| </li> |
| </ul> |
| <a name="getServerSession-jakarta.persistence.EntityManagerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerSession</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/sessions/server/Server.html" title="interface in org.eclipse.persistence.sessions.server">Server</a> getServerSession(jakarta.persistence.EntityManagerFactory emf)</pre> |
| <div class="block">Retrieve the shared server session from the EMF.</div> |
| </li> |
| </ul> |
| <a name="getSessionBroker-jakarta.persistence.EntityManagerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionBroker</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/sessions/broker/SessionBroker.html" title="class in org.eclipse.persistence.sessions.broker">SessionBroker</a> getSessionBroker(jakarta.persistence.EntityManagerFactory emf)</pre> |
| <div class="block">Retrieve the shared session broker from the EMF.</div> |
| </li> |
| </ul> |
| <a name="createEntityManagerFactory-org.eclipse.persistence.sessions.server.Server-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityManagerFactory</h4> |
| <pre>public static jakarta.persistence.EntityManagerFactory createEntityManagerFactory(<a href="../../../../org/eclipse/persistence/sessions/server/Server.html" title="interface in org.eclipse.persistence.sessions.server">Server</a> session)</pre> |
| <div class="block">Create a EclipseLink EMF given a ServerSession that has already been created |
| and logged in.</div> |
| </li> |
| </ul> |
| <a name="createEntityManagerFactory-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityManagerFactory</h4> |
| <pre>public static 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> sessionName)</pre> |
| <div class="block">Create a EclipseLink EMF using a session name and sessions.xml. This is |
| equivalent to using the EclipseLink.session-xml and EclipseLink.session-name PU |
| properties with the exception that no persistence.xml is required. |
| |
| The application would be required to manage this singleton EMF.</div> |
| </li> |
| </ul> |
| <a name="loadUnfetchedObject-org.eclipse.persistence.queries.FetchGroupTracker-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>loadUnfetchedObject</h4> |
| <pre>public static void loadUnfetchedObject(<a href="../../../../org/eclipse/persistence/queries/FetchGroupTracker.html" title="interface in org.eclipse.persistence.queries">FetchGroupTracker</a> entity)</pre> |
| <div class="block">If the object has a fetch group then the whole object is read in.</div> |
| </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/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/jpa/JpaQuery.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/jpa/JpaHelper.html" target="_top">Frames</a></li> |
| <li><a href="JpaHelper.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> |
