| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PersistenceManagerFactory (JDO API 3.2.1)</title> |
| <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="PersistenceManagerFactory (JDO API 3.2.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/PersistenceManagerFactory.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jdo/Query.html" title="interface in javax.jdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jdo/PersistenceManagerFactory.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceManagerFactory.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">javax.jdo</div> |
| <h2 title="Interface PersistenceManagerFactory" class="title">Interface PersistenceManagerFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PersistenceManagerFactory</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">The <code>PersistenceManagerFactory</code> is the interface to use to obtain |
| <code>PersistenceManager</code> instances. |
| All <code>PersistenceManager</code> instances obtained from the same |
| <code>PersistenceManagerFactory</code> will have the same default properties. |
| |
| <P><code>PersistenceManagerFactory</code> instances may be configured and |
| serialized for later use. They may be stored via JNDI and looked up |
| and used later. Any properties configured will be saved and restored. |
| |
| <P>Once the first <code>PersistenceManager</code> is obtained from the |
| <code>PersistenceManagerFactory</code>, the factory can no longer be |
| configured. |
| <P>If the <code>ConnectionFactory</code> property is set |
| (non-<code>null</code>) then all other Connection properties including |
| <code>ConnectionFactoryName</code> are ignored; |
| otherwise, if <code>ConnectionFactoryName</code> is set |
| (non-<code>null</code>) then all other Connection properties are ignored. |
| Similarly, if the <code>ConnectionFactory2</code> property is set |
| (non-<code>null</code>) then <code>ConnectionFactory2Name</code> is ignored. |
| <P>Operational state (<code>PersistenceManager</code> pooling, connection |
| pooling, operational parameters) must not be serialized.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-">addFetchGroups</a></span>(<a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>... groups)</code> |
| <div class="block">Add the <code>FetchGroup</code>s to the set of active fetch groups.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#addInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-java.lang.Class:A-">addInstanceLifecycleListener</a></span>(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[] classes)</code> |
| <div class="block">Add the parameter listener to the list of |
| instance lifecycle event listeners set as the initial listeners |
| for each PersistenceManager created by this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#close--">close</a></span>()</code> |
| <div class="block">Close this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionDriverName--">getConnectionDriverName</a></span>()</code> |
| <div class="block">Get the driver name for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionFactory--">getConnectionFactory</a></span>()</code> |
| <div class="block">Get the data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionFactory2--">getConnectionFactory2</a></span>()</code> |
| <div class="block">Get the second data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionFactory2Name--">getConnectionFactory2Name</a></span>()</code> |
| <div class="block">Get the name for the second data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionFactoryName--">getConnectionFactoryName</a></span>()</code> |
| <div class="block">Get the name for the data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionURL--">getConnectionURL</a></span>()</code> |
| <div class="block">Get the URL for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getConnectionUserName--">getConnectionUserName</a></span>()</code> |
| <div class="block">Get the user name for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getCopyOnAttach--">getCopyOnAttach</a></span>()</code> |
| <div class="block">Gets the default copyOnAttach setting for all |
| <code>PersistenceManager</code> instances obtained from this |
| factory.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/datastore/DataStoreCache.html" title="interface in javax.jdo.datastore">DataStoreCache</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getDataStoreCache--">getDataStoreCache</a></span>()</code> |
| <div class="block">Return the <a href="../../javax/jdo/datastore/DataStoreCache.html" title="interface in javax.jdo.datastore"><code>DataStoreCache</code></a> that this factory uses for |
| controlling a second-level cache.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getDatastoreReadTimeoutMillis--">getDatastoreReadTimeoutMillis</a></span>()</code> |
| <div class="block">Get the default timeout setting for read operations.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getDatastoreWriteTimeoutMillis--">getDatastoreWriteTimeoutMillis</a></span>()</code> |
| <div class="block">Get the default timeout setting for write operations.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getDetachAllOnCommit--">getDetachAllOnCommit</a></span>()</code> |
| <div class="block">Gets the detachAllOnCommit setting.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroup-java.lang.Class-java.lang.String-">getFetchGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <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> name)</code> |
| <div class="block">Create an unscoped, modifiable <code>FetchGroup</code> for the Class and |
| name.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroups--">getFetchGroups</a></span>()</code> |
| <div class="block">Get a modifiable Set containing a mutable copy of all currently active |
| (in scope) fetch groups.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getIgnoreCache--">getIgnoreCache</a></span>()</code> |
| <div class="block">Get the default IgnoreCache setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getManagedClasses--">getManagedClasses</a></span>()</code> |
| <div class="block">Method to return the currently managed classes for this factory.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getMapping--">getMapping</a></span>()</code> |
| <div class="block">Get the Mapping setting for this factory.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/metadata/TypeMetadata.html" title="interface in javax.jdo.metadata">TypeMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getMetadata-java.lang.String-">getMetadata</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> className)</code> |
| <div class="block">Method to return the metadata object for the specified class/interface, if there is |
| metadata defined for that class/interface.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getMultithreaded--">getMultithreaded</a></span>()</code> |
| <div class="block">Get the default Multithreaded setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getName--">getName</a></span>()</code> |
| <div class="block">Gets the name of this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getNontransactionalRead--">getNontransactionalRead</a></span>()</code> |
| <div class="block">Get the default NontransactionalRead setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getNontransactionalWrite--">getNontransactionalWrite</a></span>()</code> |
| <div class="block">Get the default NontransactionalWrite setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getOptimistic--">getOptimistic</a></span>()</code> |
| <div class="block">Get the default Optimistic setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceManager--">getPersistenceManager</a></span>()</code> |
| <div class="block">Get an instance of <code>PersistenceManager</code> from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceManager-java.lang.String-java.lang.String-">getPersistenceManager</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> userid, |
| <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> password)</code> |
| <div class="block">Get an instance of <code>PersistenceManager</code> from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceManagerProxy--">getPersistenceManagerProxy</a></span>()</code> |
| <div class="block">Get a thread-safe instance of a proxy that dynamically binds |
| on each method call to an instance of <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceUnitName--">getPersistenceUnitName</a></span>()</code> |
| <div class="block">Gets the PersistenceUnitName for this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">Return non-configurable properties of this |
| <code>PersistenceManagerFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getReadOnly--">getReadOnly</a></span>()</code> |
| <div class="block">Gets the value for read-only for this PMF.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getRestoreValues--">getRestoreValues</a></span>()</code> |
| <div class="block">Get the default value for the RestoreValues property.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getRetainValues--">getRetainValues</a></span>()</code> |
| <div class="block">Get the default RetainValues setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getServerTimeZoneID--">getServerTimeZoneID</a></span>()</code> |
| <div class="block">Gets the TimeZone ID of the server associated with this |
| PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getTransactionIsolationLevel--">getTransactionIsolationLevel</a></span>()</code> |
| <div class="block">Get the value for transaction isolation level for this PMF.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#getTransactionType--">getTransactionType</a></span>()</code> |
| <div class="block">Gets the TransactionType for this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#isClosed--">isClosed</a></span>()</code> |
| <div class="block">A <code>PersistenceManagerFactory</code> instance can be used |
| until it is closed.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#newMetadata--">newMetadata</a></span>()</code> |
| <div class="block">Method to return a new metadata object that can be subsequently modified |
| and registered with the persistence process using the method <a href="../../javax/jdo/PersistenceManagerFactory.html#registerMetadata-javax.jdo.metadata.JDOMetadata-"><code>registerMetadata(javax.jdo.metadata.JDOMetadata)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#registerMetadata-javax.jdo.metadata.JDOMetadata-">registerMetadata</a></span>(<a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a> metadata)</code> |
| <div class="block">Method to register metadata with the persistence process managed by this |
| <code>PersistenceManagerFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#removeAllFetchGroups--">removeAllFetchGroups</a></span>()</code> |
| <div class="block">Remove all <code>FetchGroup</code>s from the set of active |
| <code>FetchGroup</code>s.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#removeFetchGroups-javax.jdo.FetchGroup...-">removeFetchGroups</a></span>(<a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>... groups)</code> |
| <div class="block">Remove the <code>FetchGroup</code>s from the set of active |
| <code>FetchGroup</code>s.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#removeInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-">removeInstanceLifecycleListener</a></span>(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener)</code> |
| <div class="block">Remove the parameter listener instance from the list of |
| instance lifecycle event listeners set as the initial listeners |
| for each PersistenceManager created by this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionDriverName-java.lang.String-">setConnectionDriverName</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> driverName)</code> |
| <div class="block">Set the driver name for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionFactory-java.lang.Object-">setConnectionFactory</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> connectionFactory)</code> |
| <div class="block">Set the data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionFactory2-java.lang.Object-">setConnectionFactory2</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> connectionFactory)</code> |
| <div class="block">Set the second data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionFactory2Name-java.lang.String-">setConnectionFactory2Name</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> connectionFactoryName)</code> |
| <div class="block">Set the name for the second data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionFactoryName-java.lang.String-">setConnectionFactoryName</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> connectionFactoryName)</code> |
| <div class="block">Set the name for the data store connection factory.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionPassword-java.lang.String-">setConnectionPassword</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> password)</code> |
| <div class="block">Set the password for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionURL-java.lang.String-">setConnectionURL</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> url)</code> |
| <div class="block">Set the URL for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setConnectionUserName-java.lang.String-">setConnectionUserName</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> userName)</code> |
| <div class="block">Set the user name for the data store connection.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setCopyOnAttach-boolean-">setCopyOnAttach</a></span>(boolean flag)</code> |
| <div class="block">Sets the default copyOnAttach setting for all |
| <code>PersistenceManager</code> instances obtained from this |
| factory.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setDatastoreReadTimeoutMillis-java.lang.Integer-">setDatastoreReadTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</code> |
| <div class="block">Specify a default timeout interval (milliseconds) for any read |
| operations for persistence managers obtained from this persistence |
| manager factory.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-">setDatastoreWriteTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</code> |
| <div class="block">Specify a default timeout interval (milliseconds) for any write |
| operations for persistence managers obtained from this persistence |
| manager factory.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setDetachAllOnCommit-boolean-">setDetachAllOnCommit</a></span>(boolean flag)</code> |
| <div class="block">Sets the default detachAllOnCommit setting for all |
| <code>PersistenceManager</code> instances obtained from this |
| factory.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setIgnoreCache-boolean-">setIgnoreCache</a></span>(boolean flag)</code> |
| <div class="block">Set the default IgnoreCache setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setMapping-java.lang.String-">setMapping</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> mapping)</code> |
| <div class="block">Set the Mapping setting for this factory.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setMultithreaded-boolean-">setMultithreaded</a></span>(boolean flag)</code> |
| <div class="block">Set the default Multithreaded setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setName-java.lang.String-">setName</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> name)</code> |
| <div class="block">Sets the name of this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setNontransactionalRead-boolean-">setNontransactionalRead</a></span>(boolean flag)</code> |
| <div class="block">Set the default NontransactionalRead setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setNontransactionalWrite-boolean-">setNontransactionalWrite</a></span>(boolean flag)</code> |
| <div class="block">Set the default NontransactionalWrite setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setOptimistic-boolean-">setOptimistic</a></span>(boolean flag)</code> |
| <div class="block">Set the default Optimistic setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setPersistenceUnitName-java.lang.String-">setPersistenceUnitName</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> name)</code> |
| <div class="block">Sets the PersistenceUnitName for this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setReadOnly-boolean-">setReadOnly</a></span>(boolean flag)</code> |
| <div class="block">Sets the value for whether the datastore is to be considered |
| read-only.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setRestoreValues-boolean-">setRestoreValues</a></span>(boolean restoreValues)</code> |
| <div class="block">Set the default value for the RestoreValues property.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setRetainValues-boolean-">setRetainValues</a></span>(boolean flag)</code> |
| <div class="block">Set the default RetainValues setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setServerTimeZoneID-java.lang.String-">setServerTimeZoneID</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> timezoneid)</code> |
| <div class="block">Sets the TimeZone ID of the server associated with this |
| PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setTransactionIsolationLevel-java.lang.String-">setTransactionIsolationLevel</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> level)</code> |
| <div class="block">Set the value for transaction isolation level for this PMF.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#setTransactionType-java.lang.String-">setTransactionType</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> name)</code> |
| <div class="block">Sets the TransactionType for this PersistenceManagerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManagerFactory.html#supportedOptions--">supportedOptions</a></span>()</code> |
| <div class="block">The application can determine from the results of this |
| method which optional features, and which query languages |
| are supported by the JDO implementation.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Close this PersistenceManagerFactory. Check for |
| JDOPermission("closePersistenceManagerFactory") and if not authorized, |
| throw SecurityException. |
| <P>If the authorization check succeeds, check to see that all |
| PersistenceManager instances obtained from this PersistenceManagerFactory |
| have no active transactions. If any PersistenceManager instances have |
| an active transaction, throw a JDOUserException, with one nested |
| JDOUserException for each PersistenceManager with an active Transaction. |
| <P>If there are no active transactions, then close all PersistenceManager |
| instances obtained from this PersistenceManagerFactory, mark this |
| PersistenceManagerFactory as closed, disallow getPersistenceManager |
| methods, and allow all other get methods. If a set method or |
| getPersistenceManager method is called after close, then |
| JDOUserException is thrown.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isClosed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClosed</h4> |
| <pre>boolean isClosed()</pre> |
| <div class="block">A <code>PersistenceManagerFactory</code> instance can be used |
| until it is closed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this <code>PersistenceManagerFactory</code> |
| has been closed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#close--"><code>close()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceManager</h4> |
| <pre><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a> getPersistenceManager()</pre> |
| <div class="block">Get an instance of <code>PersistenceManager</code> from this factory. |
| The instance has default values for options. |
| |
| <P>After the first use of <code>getPersistenceManager</code>, no "set" |
| methods will succeed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>PersistenceManager</code> instance with default options.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceManagerProxy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceManagerProxy</h4> |
| <pre><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a> getPersistenceManagerProxy()</pre> |
| <div class="block">Get a thread-safe instance of a proxy that dynamically binds |
| on each method call to an instance of <code>PersistenceManager</code>. |
| <P>When used with a <code>PersistenceManagerFactory</code> |
| that uses TransactionType JTA, |
| the proxy can be used in a server to dynamically bind to an instance |
| from this factory associated with the thread's current transaction. |
| In this case, the close method is ignored, as the |
| <code>PersistenceManager</code> is automatically closed when the |
| transaction completes. |
| <P>When used with a <code>PersistenceManagerFactory</code> |
| that uses TransactionType RESOURCE_LOCAL, the proxy uses an inheritable |
| ThreadLocal to bind to an instance of <code>PersistenceManager</code> |
| associated with the thread. In this case, the close method executed |
| on the proxy closes the <code>PersistenceManager</code> and then |
| clears the ThreadLocal. |
| Use of this method does not affect the configurability of the |
| <code>PersistenceManagerFactory</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>PersistenceManager</code> proxy.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceManager-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceManager</h4> |
| <pre><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a> getPersistenceManager(<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> userid, |
| <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> password)</pre> |
| <div class="block">Get an instance of <code>PersistenceManager</code> from this factory. |
| The instance has default values for options. |
| The parameters <code>userid</code> and <code>password</code> are used |
| when obtaining datastore connections from the connection pool. |
| |
| <P>After the first use of <code>getPersistenceManager</code>, no "set" |
| methods will succeed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userid</code> - the userid for the connection</dd> |
| <dd><code>password</code> - the password for the connection</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>PersistenceManager</code> instance with default options.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionUserName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionUserName</h4> |
| <pre>void setConnectionUserName(<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> userName)</pre> |
| <div class="block">Set the user name for the data store connection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userName</code> - the user name for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionUserName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionUserName</h4> |
| <pre><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> getConnectionUserName()</pre> |
| <div class="block">Get the user name for the data store connection.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user name for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionPassword-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionPassword</h4> |
| <pre>void setConnectionPassword(<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> password)</pre> |
| <div class="block">Set the password for the data store connection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>password</code> - the password for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionURL-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionURL</h4> |
| <pre>void setConnectionURL(<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> url)</pre> |
| <div class="block">Set the URL for the data store connection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>url</code> - the URL for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionURL--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionURL</h4> |
| <pre><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> getConnectionURL()</pre> |
| <div class="block">Get the URL for the data store connection.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URL for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionDriverName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionDriverName</h4> |
| <pre>void setConnectionDriverName(<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> driverName)</pre> |
| <div class="block">Set the driver name for the data store connection. |
| This property might be ignored by the JDO implementation |
| because the JDBC DriverManager handles the driver name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>driverName</code> - the driver name for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionDriverName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionDriverName</h4> |
| <pre><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> getConnectionDriverName()</pre> |
| <div class="block">Get the driver name for the data store connection. |
| This property might be ignored by the JDO implementation |
| because the JDBC DriverManager handles the driver name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the driver name for the data store connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionFactoryName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionFactoryName</h4> |
| <pre>void setConnectionFactoryName(<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> connectionFactoryName)</pre> |
| <div class="block">Set the name for the data store connection factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionFactoryName</code> - the name of the data store connection |
| factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionFactoryName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionFactoryName</h4> |
| <pre><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> getConnectionFactoryName()</pre> |
| <div class="block">Get the name for the data store connection factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the data store connection factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionFactory-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionFactory</h4> |
| <pre>void setConnectionFactory(<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> connectionFactory)</pre> |
| <div class="block">Set the data store connection factory. JDO implementations |
| will support specific connection factories. The connection |
| factory interfaces are not part of the JDO specification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionFactory</code> - the data store connection factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionFactory</h4> |
| <pre><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> getConnectionFactory()</pre> |
| <div class="block">Get the data store connection factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the data store connection factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionFactory2Name-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionFactory2Name</h4> |
| <pre>void setConnectionFactory2Name(<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> connectionFactoryName)</pre> |
| <div class="block">Set the name for the second data store connection factory. This is |
| needed for managed environments to get nontransactional connections for |
| optimistic transactions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionFactoryName</code> - the name of the data store connection |
| factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionFactory2Name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionFactory2Name</h4> |
| <pre><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> getConnectionFactory2Name()</pre> |
| <div class="block">Get the name for the second data store connection factory. This is |
| needed for managed environments to get nontransactional connections for |
| optimistic transactions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the data store connection factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectionFactory2-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionFactory2</h4> |
| <pre>void setConnectionFactory2(<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> connectionFactory)</pre> |
| <div class="block">Set the second data store connection factory. This is |
| needed for managed environments to get nontransactional connections for |
| optimistic transactions. JDO implementations |
| will support specific connection factories. The connection |
| factory interfaces are not part of the JDO specification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionFactory</code> - the data store connection factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnectionFactory2--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionFactory2</h4> |
| <pre><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> getConnectionFactory2()</pre> |
| <div class="block">Get the second data store connection factory. This is |
| needed for managed environments to get nontransactional connections for |
| optimistic transactions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the data store connection factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMultithreaded-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMultithreaded</h4> |
| <pre>void setMultithreaded(boolean flag)</pre> |
| <div class="block">Set the default Multithreaded setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default Multithreaded setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMultithreaded--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMultithreaded</h4> |
| <pre>boolean getMultithreaded()</pre> |
| <div class="block">Get the default Multithreaded setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default Multithreaded setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMapping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMapping</h4> |
| <pre>void setMapping(<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> mapping)</pre> |
| <div class="block">Set the Mapping setting for this factory. This is used to find the |
| object-datastore mapping file(s).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mapping</code> - the Mapping setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapping</h4> |
| <pre><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> getMapping()</pre> |
| <div class="block">Get the Mapping setting for this factory. This is used to find the |
| object-datastore mapping file(s).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Mapping setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOptimistic-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOptimistic</h4> |
| <pre>void setOptimistic(boolean flag)</pre> |
| <div class="block">Set the default Optimistic setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default Optimistic setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOptimistic--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptimistic</h4> |
| <pre>boolean getOptimistic()</pre> |
| <div class="block">Get the default Optimistic setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default Optimistic setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRetainValues-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRetainValues</h4> |
| <pre>void setRetainValues(boolean flag)</pre> |
| <div class="block">Set the default RetainValues setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default RetainValues setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRetainValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetainValues</h4> |
| <pre>boolean getRetainValues()</pre> |
| <div class="block">Get the default RetainValues setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default RetainValues setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRestoreValues-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRestoreValues</h4> |
| <pre>void setRestoreValues(boolean restoreValues)</pre> |
| <div class="block">Set the default value for the RestoreValues property. |
| If <code>true</code>, at rollback, fields of newly persistent instances |
| are restored to |
| their values as of the beginning of the transaction, and the instances |
| revert to transient. Additionally, fields of modified |
| instances of primitive types and immutable reference types |
| are restored to their values as of the beginning of the |
| transaction. |
| <P>If <code>false</code>, at rollback, the values of fields of |
| newly persistent instances are unchanged and the instances revert to |
| transient. Additionally, dirty instances transition to hollow. |
| If an implementation does not support this option, a |
| <code>JDOUnsupportedOptionException</code> is thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>restoreValues</code> - the value of the restoreValues property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRestoreValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRestoreValues</h4> |
| <pre>boolean getRestoreValues()</pre> |
| <div class="block">Get the default value for the RestoreValues property.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the restoreValues property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNontransactionalRead-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNontransactionalRead</h4> |
| <pre>void setNontransactionalRead(boolean flag)</pre> |
| <div class="block">Set the default NontransactionalRead setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default NontransactionalRead setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNontransactionalRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNontransactionalRead</h4> |
| <pre>boolean getNontransactionalRead()</pre> |
| <div class="block">Get the default NontransactionalRead setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default NontransactionalRead setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNontransactionalWrite-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNontransactionalWrite</h4> |
| <pre>void setNontransactionalWrite(boolean flag)</pre> |
| <div class="block">Set the default NontransactionalWrite setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default NontransactionalWrite setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNontransactionalWrite--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNontransactionalWrite</h4> |
| <pre>boolean getNontransactionalWrite()</pre> |
| <div class="block">Get the default NontransactionalWrite setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default NontransactionalWrite setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIgnoreCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreCache</h4> |
| <pre>void setIgnoreCache(boolean flag)</pre> |
| <div class="block">Set the default IgnoreCache setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default IgnoreCache setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIgnoreCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreCache</h4> |
| <pre>boolean getIgnoreCache()</pre> |
| <div class="block">Get the default IgnoreCache setting for all |
| <code>PersistenceManager</code> instances obtained from this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default IngoreCache setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDetachAllOnCommit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetachAllOnCommit</h4> |
| <pre>boolean getDetachAllOnCommit()</pre> |
| <div class="block">Gets the detachAllOnCommit setting.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default detachAllOnCommit setting.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setDetachAllOnCommit-boolean-"><code>setDetachAllOnCommit(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDetachAllOnCommit-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetachAllOnCommit</h4> |
| <pre>void setDetachAllOnCommit(boolean flag)</pre> |
| <div class="block">Sets the default detachAllOnCommit setting for all |
| <code>PersistenceManager</code> instances obtained from this |
| factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the default DetachAllOnCommit setting</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getDetachAllOnCommit--"><code>getDetachAllOnCommit()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCopyOnAttach--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCopyOnAttach</h4> |
| <pre>boolean getCopyOnAttach()</pre> |
| <div class="block">Gets the default copyOnAttach setting for all |
| <code>PersistenceManager</code> instances obtained from this |
| factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the copyOnAttach setting.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setCopyOnAttach-boolean-"><code>setCopyOnAttach(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCopyOnAttach-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCopyOnAttach</h4> |
| <pre>void setCopyOnAttach(boolean flag)</pre> |
| <div class="block">Sets the default copyOnAttach setting for all |
| <code>PersistenceManager</code> instances obtained from this |
| factory. |
| |
| <P>CopyOnAttach set to <code>true</code> specifies that during |
| makePersistent, copies are made of detached parameter instances. |
| With this flag set to <code>false</code>, detached parameter |
| instances are attached directly and change their state from |
| detached-clean to persistent-clean or from detached-dirty to |
| persistent-dirty.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - Whether we should copy on attach</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getCopyOnAttach--"><code>getCopyOnAttach()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>void setName(<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> name)</pre> |
| <div class="block">Sets the name of this PersistenceManagerFactory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of this PMF</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><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> getName()</pre> |
| <div class="block">Gets the name of this PersistenceManagerFactory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of this PMF</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPersistenceUnitName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPersistenceUnitName</h4> |
| <pre>void setPersistenceUnitName(<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> name)</pre> |
| <div class="block">Sets the PersistenceUnitName for this PersistenceManagerFactory. |
| This has the same semantics as the same-named property in |
| JSR-220 PersistenceUnitInfo.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the PersistenceUnitName</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceUnitName--"><code>getPersistenceUnitName()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceUnitName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceUnitName</h4> |
| <pre><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> getPersistenceUnitName()</pre> |
| <div class="block">Gets the PersistenceUnitName for this PersistenceManagerFactory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the PersistenceUnitName</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setPersistenceUnitName-java.lang.String-"><code>setPersistenceUnitName(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setServerTimeZoneID-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServerTimeZoneID</h4> |
| <pre>void setServerTimeZoneID(<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> timezoneid)</pre> |
| <div class="block">Sets the TimeZone ID of the server associated with this |
| PersistenceManagerFactory. The parameter is a String |
| suitable for use with TimeZone.getTimeZone(). The String |
| must match an ID returned by TimeZone.getAvailableIDs(). |
| If the ServerTimeZoneID is not set, or set to the null String, |
| assume that the server has the same TimeZone ID as the client. |
| If incorrectly set, the result of PersistenceManager.getServerDate() |
| might be incorrect.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timezoneid</code> - the TimeZone ID of the server</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the parameter does not match |
| an ID from TimeZone.getAvailableIDs()</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getServerTimeZoneID--"><code>getServerTimeZoneID()</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true#getTimeZone-java.lang.String-" title="class or interface in java.util"><code>TimeZone.getTimeZone(String)</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true#getAvailableIDs--" title="class or interface in java.util"><code>TimeZone.getAvailableIDs()</code></a>, |
| <a href="../../javax/jdo/PersistenceManager.html#getServerDate--"><code>PersistenceManager.getServerDate()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerTimeZoneID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerTimeZoneID</h4> |
| <pre><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> getServerTimeZoneID()</pre> |
| <div class="block">Gets the TimeZone ID of the server associated with this |
| PersistenceManagerFactory. If not set, assume that |
| the server has the same TimeZone ID as the client.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the TimeZone of the server</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setServerTimeZoneID-java.lang.String-"><code>setServerTimeZoneID(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTransactionType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransactionType</h4> |
| <pre>void setTransactionType(<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> name)</pre> |
| <div class="block">Sets the TransactionType for this PersistenceManagerFactory. |
| Permitted values are "JTA" and "RESOURCE_LOCAL". |
| This has the same semantics as the same-named property in |
| JSR-220 EntityManagerFactory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the TransactionType</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the parameter is not a permitted value</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getTransactionType--"><code>getTransactionType()</code></a>, |
| <a href="../../javax/jdo/Constants.html#JTA"><code>Constants.JTA</code></a>, |
| <a href="../../javax/jdo/Constants.html#RESOURCE_LOCAL"><code>Constants.RESOURCE_LOCAL</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransactionType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionType</h4> |
| <pre><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> getTransactionType()</pre> |
| <div class="block">Gets the TransactionType for this PersistenceManagerFactory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the TransactionType</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setTransactionType-java.lang.String-"><code>setTransactionType(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadOnly</h4> |
| <pre>boolean getReadOnly()</pre> |
| <div class="block">Gets the value for read-only for this PMF. |
| Indicates whether the datastore is read-only or writable.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the readOnly setting.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setReadOnly-boolean-"><code>setReadOnly(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadOnly-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre>void setReadOnly(boolean flag)</pre> |
| <div class="block">Sets the value for whether the datastore is to be considered |
| read-only. |
| |
| <P>ReadOnly set to <code>false</code> specifies that no updates |
| can be performed to the datastore, and if updates are attempted |
| a JDOReadOnlyException is thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - whether we should consider this datastore read-only</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getReadOnly--"><code>getReadOnly()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransactionIsolationLevel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionIsolationLevel</h4> |
| <pre><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> getTransactionIsolationLevel()</pre> |
| <div class="block">Get the value for transaction isolation level for this PMF.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the transaction isolation level</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setTransactionIsolationLevel-java.lang.String-"><code>setTransactionIsolationLevel(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTransactionIsolationLevel-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransactionIsolationLevel</h4> |
| <pre>void setTransactionIsolationLevel(<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> level)</pre> |
| <div class="block">Set the value for transaction isolation level for this PMF. |
| Transaction isolation levels are defined in javax.jdo.Constants. |
| If the requested level is not available, but a higher level is |
| available, the higher level is silently used. |
| If the requested level is not available, and no higher level is |
| available, then JDOUnsupportedOptionException is thrown. |
| Standard values in order from low to high are: |
| <ul><li>read-uncommitted |
| </li><li>read-committed |
| </li><li>repeatable-read |
| </li><li>snapshot |
| </li><li>serializable |
| </li></ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>level</code> - the transaction isolation level</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#getTransactionIsolationLevel--"><code>getTransactionIsolationLevel()</code></a>, |
| <a href="../../javax/jdo/Constants.html#TX_READ_UNCOMMITTED"><code>Constants.TX_READ_UNCOMMITTED</code></a>, |
| <a href="../../javax/jdo/Constants.html#TX_READ_COMMITTED"><code>Constants.TX_READ_COMMITTED</code></a>, |
| <a href="../../javax/jdo/Constants.html#TX_REPEATABLE_READ"><code>Constants.TX_REPEATABLE_READ</code></a>, |
| <a href="../../javax/jdo/Constants.html#TX_SNAPSHOT"><code>Constants.TX_SNAPSHOT</code></a>, |
| <a href="../../javax/jdo/Constants.html#TX_SERIALIZABLE"><code>Constants.TX_SERIALIZABLE</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDatastoreReadTimeoutMillis-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDatastoreReadTimeoutMillis</h4> |
| <pre>void setDatastoreReadTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</pre> |
| <div class="block">Specify a default timeout interval (milliseconds) for any read |
| operations for persistence managers obtained from this persistence |
| manager factory. To unset the explicit timeout, specify null. |
| For no timeout, specify 0. |
| If the datastore and JDO implementation support timeouts, then |
| javax.jdo.option.DatastoreTimeout is returned by supportedOptions(). |
| If timeouts are not supported,this method will throw |
| JDOUnsupportedOptionException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interval</code> - the timeout interval (milliseconds)</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatastoreReadTimeoutMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatastoreReadTimeoutMillis</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getDatastoreReadTimeoutMillis()</pre> |
| <div class="block">Get the default timeout setting for read operations. |
| If timeouts are not supported,this method will return null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default timeout setting (milliseconds).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setDatastoreReadTimeoutMillis-java.lang.Integer-"><code>setDatastoreReadTimeoutMillis(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDatastoreWriteTimeoutMillis-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDatastoreWriteTimeoutMillis</h4> |
| <pre>void setDatastoreWriteTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</pre> |
| <div class="block">Specify a default timeout interval (milliseconds) for any write |
| operations for persistence managers obtained from this persistence |
| manager factory. To unset the explicit timeout, specify null. |
| For no timeout, specify 0. |
| If the datastore and JDO implementation support timeouts, then |
| javax.jdo.option.DatastoreTimeout is returned by supportedOptions(). |
| If timeouts are not supported,this method will throw |
| JDOUnsupportedOptionException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interval</code> - the timeout interval (milliseconds)</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatastoreWriteTimeoutMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatastoreWriteTimeoutMillis</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getDatastoreWriteTimeoutMillis()</pre> |
| <div class="block">Get the default timeout setting for write operations. |
| If timeouts are not supported,this method will return null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default timeout setting (milliseconds).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManagerFactory.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-"><code>setDatastoreWriteTimeoutMillis(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getProperties()</pre> |
| <div class="block">Return non-configurable properties of this |
| <code>PersistenceManagerFactory</code>. |
| Properties with keys <code>VendorName</code> and |
| <code>VersionNumber</code> are required. Other keys are optional.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the non-configurable properties of this |
| <code>PersistenceManagerFactory</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supportedOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportedOptions</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<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>> supportedOptions()</pre> |
| <div class="block">The application can determine from the results of this |
| method which optional features, and which query languages |
| are supported by the JDO implementation. |
| <P>Each supported JDO feature is represented by a |
| <code>String</code> with one of the following values: |
| |
| <P><code>javax.jdo.option.TransientTransactional |
| <BR>javax.jdo.option.NontransactionalRead |
| <BR>javax.jdo.option.NontransactionalWrite |
| <BR>javax.jdo.option.RetainValues |
| <BR>javax.jdo.option.Optimistic |
| <BR>javax.jdo.option.ApplicationIdentity |
| <BR>javax.jdo.option.DatastoreIdentity |
| <BR>javax.jdo.option.NonDurableIdentity |
| <BR>javax.jdo.option.ArrayList |
| <BR>javax.jdo.option.HashMap |
| <BR>javax.jdo.option.Hashtable |
| <BR>javax.jdo.option.LinkedList |
| <BR>javax.jdo.option.TreeMap |
| <BR>javax.jdo.option.TreeSet |
| <BR>javax.jdo.option.Vector |
| <BR>javax.jdo.option.Map |
| <BR>javax.jdo.option.List |
| <BR>javax.jdo.option.Array |
| <BR>javax.jdo.option.NullCollection |
| <BR>javax.jdo.option.ChangeApplicationIdentity |
| <BR>javax.jdo.option.BinaryCompatibility |
| <BR>javax.jdo.option.GetDataStoreConnection |
| <BR>javax.jdo.option.UnconstrainedQueryVariables |
| <BR>javax.jdo.option.TransactionIsolationLevel.read-uncommitted |
| <BR>javax.jdo.option.TransactionIsolationLevel.read-committed |
| <BR>javax.jdo.option.TransactionIsolationLevel.repeatable-read |
| <BR>javax.jdo.option.TransactionIsolationLevel.snapshot |
| <BR>javax.jdo.option.TransactionIsolationLevel.serializable |
| <BR>javax.jdo.option.QueryCancel |
| <BR>javax.jdo.option.DatastoreTimeout |
| <BR>javax.jdo.query.SQL |
| <BR>javax.jdo.query.JDOQL |
| </code> |
| |
| <P>The standard JDO query language is represented by a |
| <code>String</code>: |
| <P><code>javax.jdo.query.JDOQL</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Collection</code> of <code>String</code>s representing |
| the supported options.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataStoreCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreCache</h4> |
| <pre><a href="../../javax/jdo/datastore/DataStoreCache.html" title="interface in javax.jdo.datastore">DataStoreCache</a> getDataStoreCache()</pre> |
| <div class="block">Return the <a href="../../javax/jdo/datastore/DataStoreCache.html" title="interface in javax.jdo.datastore"><code>DataStoreCache</code></a> that this factory uses for |
| controlling a second-level cache. If this factory does not use |
| a second-level cache, the returned instance does nothing. This |
| method never returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the DataStoreCache</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-java.lang.Class:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addInstanceLifecycleListener</h4> |
| <pre>void addInstanceLifecycleListener(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[] classes)</pre> |
| <div class="block">Add the parameter listener to the list of |
| instance lifecycle event listeners set as the initial listeners |
| for each PersistenceManager created by this PersistenceManagerFactory. |
| The <code>addInstanceLifecycleListener</code> and |
| <code>removeInstanceLifecycleListener</code> |
| methods are considered to be configuration methods and |
| can only be called when the PersistenceManagerFactory |
| is configurable (before the first time <a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceManager--"><code>getPersistenceManager()</code></a> |
| is called). |
| <p>The <code>classes</code> parameter identifies all |
| of the classes of interest. If the <code>classes</code> |
| parameter is specified as <code>null</code>, events for all |
| persistent classes and interfaces will be sent to the listener.</p> |
| <p>The listener will be called for each event for which it |
| implements the corresponding <a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener"><code>InstanceLifecycleListener</code></a> |
| interface.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the lifecycle listener</dd> |
| <dd><code>classes</code> - the classes of interest to the listener</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeInstanceLifecycleListener</h4> |
| <pre>void removeInstanceLifecycleListener(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener)</pre> |
| <div class="block">Remove the parameter listener instance from the list of |
| instance lifecycle event listeners set as the initial listeners |
| for each PersistenceManager created by this PersistenceManagerFactory. |
| The <code>addInstanceLifecycleListener</code> and |
| <code>removeInstanceLifecycleListener</code> |
| methods are considered to be configuration methods and |
| can only be called when the PersistenceManagerFactory |
| is configurable (before the first time <a href="../../javax/jdo/PersistenceManagerFactory.html#getPersistenceManager--"><code>getPersistenceManager()</code></a> |
| is called).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener instance to be removed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFetchGroups-javax.jdo.FetchGroup...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFetchGroups</h4> |
| <pre>void addFetchGroups(<a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>... groups)</pre> |
| <div class="block">Add the <code>FetchGroup</code>s to the set of active fetch groups. |
| <code>FetchGroup</code>s are made unmodifiable before being added. |
| <code>FetchGroup</code>s that match existing <code>FetchGroup</code>s |
| replace the corresponding <code>FetchGroup</code>s. |
| The replaced <code>FetchGroup</code>s become unscoped. |
| Match is based on identical class and equal name. |
| The methods <a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>addFetchGroups(javax.jdo.FetchGroup...)</code></a>, <a href="../../javax/jdo/PersistenceManagerFactory.html#removeFetchGroups-javax.jdo.FetchGroup...-"><code>removeFetchGroups(javax.jdo.FetchGroup...)</code></a>, |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroups--"><code>getFetchGroups()</code></a>, and <a href="../../javax/jdo/PersistenceManagerFactory.html#removeAllFetchGroups--"><code>removeAllFetchGroups()</code></a> |
| are internally serialized.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groups</code> - an array of FetchGroups</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if the caller is not authorized for |
| <a href="../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi"><code>JDOPermission</code></a> ("manageMetadata")</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFetchGroups-javax.jdo.FetchGroup...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFetchGroups</h4> |
| <pre>void removeFetchGroups(<a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a>... groups)</pre> |
| <div class="block">Remove the <code>FetchGroup</code>s from the set of active |
| <code>FetchGroup</code>s. Existing <code>FetchGroup</code>s that match |
| parameter <code>FetchGroup</code>s are removed. Parameter |
| <code>FetchGroup</code>s that do not match any existing |
| <code>FetchGroup</code> are ignored. |
| Removed <code>FetchGroup</code>s become unscoped. |
| Match is based on identical class and equal name. |
| The methods <a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>addFetchGroups(javax.jdo.FetchGroup...)</code></a>, <a href="../../javax/jdo/PersistenceManagerFactory.html#removeFetchGroups-javax.jdo.FetchGroup...-"><code>removeFetchGroups(javax.jdo.FetchGroup...)</code></a>, |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroups--"><code>getFetchGroups()</code></a>, and <a href="../../javax/jdo/PersistenceManagerFactory.html#removeAllFetchGroups--"><code>removeAllFetchGroups()</code></a> |
| are internally serialized.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groups</code> - an array of FetchGroups</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if the caller is not authorized for |
| <a href="../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi"><code>JDOPermission</code></a> ("manageMetadata")</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAllFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllFetchGroups</h4> |
| <pre>void removeAllFetchGroups()</pre> |
| <div class="block">Remove all <code>FetchGroup</code>s from the set of active |
| <code>FetchGroup</code>s. |
| All removed <code>FetchGroup</code>s become unscoped. |
| The methods <a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>addFetchGroups(javax.jdo.FetchGroup...)</code></a>, <a href="../../javax/jdo/PersistenceManagerFactory.html#removeFetchGroups-javax.jdo.FetchGroup...-"><code>removeFetchGroups(javax.jdo.FetchGroup...)</code></a>, |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroups--"><code>getFetchGroups()</code></a>, and <a href="../../javax/jdo/PersistenceManagerFactory.html#removeAllFetchGroups--"><code>removeAllFetchGroups()</code></a> |
| are internally serialized.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if the caller is not authorized for |
| <a href="../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi"><code>JDOPermission</code></a> ("manageMetadata")</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchGroup-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroup</h4> |
| <pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a> getFetchGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| <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> name)</pre> |
| <div class="block">Create an unscoped, modifiable <code>FetchGroup</code> for the Class and |
| name. If a corresponding <code>FetchGroup</code> already exists in |
| <code>PersistenceManagerFactory</code> scope, copy its definition |
| to a new <code>FetchGroup</code>. |
| If the <code>FetchGroup</code> does not already exist, create it |
| with no members. The <code>FetchGroup</code> does not become |
| in scope until it is added to the current set via |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>addFetchGroups(javax.jdo.FetchGroup...)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the class or interface for the FetchGroup</dd> |
| <dd><code>name</code> - the name of the fetch group</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the FetchGroup</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the class is not a persistence-capable |
| class or interface</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchGroups--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroups</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> getFetchGroups()</pre> |
| <div class="block">Get a modifiable Set containing a mutable copy of all currently active |
| (in scope) fetch groups. |
| The methods <a href="../../javax/jdo/PersistenceManagerFactory.html#addFetchGroups-javax.jdo.FetchGroup...-"><code>addFetchGroups(javax.jdo.FetchGroup...)</code></a>, <a href="../../javax/jdo/PersistenceManagerFactory.html#removeFetchGroups-javax.jdo.FetchGroup...-"><code>removeFetchGroups(javax.jdo.FetchGroup...)</code></a>, |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#getFetchGroups--"><code>getFetchGroups()</code></a>, and <a href="../../javax/jdo/PersistenceManagerFactory.html#removeAllFetchGroups--"><code>removeAllFetchGroups()</code></a> |
| are internally serialized.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of all currently active fetch groups</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if the caller is not authorized for |
| <a href="../../javax/jdo/spi/JDOPermission.html" title="class in javax.jdo.spi"><code>JDOPermission</code></a> ("getMetadata")</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMetadata-javax.jdo.metadata.JDOMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetadata</h4> |
| <pre>void registerMetadata(<a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a> metadata)</pre> |
| <div class="block">Method to register metadata with the persistence process managed by this |
| <code>PersistenceManagerFactory</code>. |
| Metadata can be created using the method <a href="../../javax/jdo/PersistenceManagerFactory.html#newMetadata--"><code>newMetadata()</code></a>. |
| If there is already metadata registered for a class contained in this metadata |
| object then a JDOUserException will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - The Metadata to register.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newMetadata</h4> |
| <pre><a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a> newMetadata()</pre> |
| <div class="block">Method to return a new metadata object that can be subsequently modified |
| and registered with the persistence process using the method <a href="../../javax/jdo/PersistenceManagerFactory.html#registerMetadata-javax.jdo.metadata.JDOMetadata-"><code>registerMetadata(javax.jdo.metadata.JDOMetadata)</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The metadata</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetadata-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre><a href="../../javax/jdo/metadata/TypeMetadata.html" title="interface in javax.jdo.metadata">TypeMetadata</a> getMetadata(<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> className)</pre> |
| <div class="block">Method to return the metadata object for the specified class/interface, if there is |
| metadata defined for that class/interface. |
| If there is no metadata for the specified class/interface, or the parameter is null, |
| then null will be returned.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>className</code> - Name of the class to get metadata for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The metadata</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedClasses--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getManagedClasses</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>> getManagedClasses()</pre> |
| <div class="block">Method to return the currently managed classes for this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Collection of persistable classes that are managed by this factory</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</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="class-use/PersistenceManagerFactory.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jdo/Query.html" title="interface in javax.jdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jdo/PersistenceManagerFactory.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceManagerFactory.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2005–2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |