blob: 4bf8f1c1ae13bad0031b79b65712e2684287c0ec [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:25 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JDBCStore (OpenJPA Parent POM 3.1.2 API)</title>
<meta name="date" content="2020-09-03">
<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="JDBCStore (OpenJPA Parent POM 3.1.2 API)";
}
}
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};
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/JDBCStore.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="../../../../../org/apache/openjpa/jdbc/kernel/JDBCSeq.html" title="interface in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/JDBCStore.html" target="_top">Frames</a></li>
<li><a href="JDBCStore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.jdbc.kernel</div>
<h2 title="Interface JDBCStore" class="title">Interface JDBCStore</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreManager.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCStoreManager</a>, <a href="../../../../../org/apache/openjpa/slice/jdbc/SliceStoreManager.html" title="class in org.apache.openjpa.slice.jdbc">SliceStoreManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JDBCStore</span></pre>
<div class="block">Represents the JDBC store.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Abe White</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><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="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#find-java.lang.Object-org.apache.openjpa.jdbc.meta.ValueMapping-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-">find</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>&nbsp;oid,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch)</code>
<div class="block">Find the object with the given oid.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getConfiguration--">getConfiguration</a></span>()</code>
<div class="block">Return the configuration for this runtime.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getConnection--">getConnection</a></span>()</code>
<div class="block">Return a SQL connection to the database.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getContext--">getContext</a></span>()</code>
<div class="block">Current persistence context.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getDBDictionary--">getDBDictionary</a></span>()</code>
<div class="block">Return the dictionary in use.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getFetchConfiguration--">getFetchConfiguration</a></span>()</code>
<div class="block">Return the current default fetch configuration.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCLockManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getLockManager--">getLockManager</a></span>()</code>
<div class="block">If the lock manager in use is a <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" title="interface in org.apache.openjpa.jdbc.kernel"><code>JDBCLockManager</code></a>, return it.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getNewConnection--">getNewConnection</a></span>()</code>
<div class="block">Return a new SQL connection to the database.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/SQLFactory.html" title="interface in org.apache.openjpa.jdbc.sql">SQLFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getSQLFactory--">getSQLFactory</a></span>()</code>
<div class="block">Return the SQL factory for this runtime.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#loadSubclasses-org.apache.openjpa.jdbc.meta.ClassMapping-">loadSubclasses</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;mapping)</code>
<div class="block">Makes sure all subclasses of the given type are loaded in the JVM.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/util/Id.html" title="class in org.apache.openjpa.util">Id</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#newDataStoreId-long-org.apache.openjpa.jdbc.meta.ClassMapping-boolean-">newDataStoreId</a></span>(long&nbsp;id,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;mapping,
boolean&nbsp;subs)</code>
<div class="block">Create a new datastore identity object from the given id value and
mapping.</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="getContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre><a href="../../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a>&nbsp;getContext()</pre>
<div class="block">Current persistence context.</div>
</li>
</ul>
<a name="getConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a>&nbsp;getConfiguration()</pre>
<div class="block">Return the configuration for this runtime.</div>
</li>
</ul>
<a name="getDBDictionary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDBDictionary</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a>&nbsp;getDBDictionary()</pre>
<div class="block">Return the dictionary in use.</div>
</li>
</ul>
<a name="getSQLFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSQLFactory</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/sql/SQLFactory.html" title="interface in org.apache.openjpa.jdbc.sql">SQLFactory</a>&nbsp;getSQLFactory()</pre>
<div class="block">Return the SQL factory for this runtime.</div>
</li>
</ul>
<a name="getLockManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockManager</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCLockManager</a>&nbsp;getLockManager()</pre>
<div class="block">If the lock manager in use is a <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" title="interface in org.apache.openjpa.jdbc.kernel"><code>JDBCLockManager</code></a>, return it.</div>
</li>
</ul>
<a name="getConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;getConnection()</pre>
<div class="block">Return a SQL connection to the database.
The <code>close</code> method should always be called on the connection
to free any resources it is using. When appropriate, the close
method is implemented as a no-op.</div>
</li>
</ul>
<a name="getNewConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNewConnection</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;getNewConnection()</pre>
<div class="block">Return a new SQL connection to the database.
This is used when the current connection still has a open result set
and a new database operation needs to be done.
The <code>close</code> method should always be called on the connection
to free any resources it is using. When appropriate, the close
method is implemented as a no-op.</div>
</li>
</ul>
<a name="getFetchConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchConfiguration</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;getFetchConfiguration()</pre>
<div class="block">Return the current default fetch configuration.</div>
</li>
</ul>
<a name="newDataStoreId-long-org.apache.openjpa.jdbc.meta.ClassMapping-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newDataStoreId</h4>
<pre><a href="../../../../../org/apache/openjpa/util/Id.html" title="class in org.apache.openjpa.util">Id</a>&nbsp;newDataStoreId(long&nbsp;id,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;mapping,
boolean&nbsp;subs)</pre>
<div class="block">Create a new datastore identity object from the given id value and
mapping.</div>
</li>
</ul>
<a name="find-java.lang.Object-org.apache.openjpa.jdbc.meta.ValueMapping-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>find</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>&nbsp;find(<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>&nbsp;oid,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch)</pre>
<div class="block">Find the object with the given oid. Convenience method on top of
the store's persistence context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vm</code> - the mapping holding this oid, or null if not applicable</dd>
</dl>
</li>
</ul>
<a name="loadSubclasses-org.apache.openjpa.jdbc.meta.ClassMapping-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadSubclasses</h4>
<pre>void&nbsp;loadSubclasses(<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;mapping)</pre>
<div class="block">Makes sure all subclasses of the given type are loaded in the JVM.
This is usually done automatically.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JDBCStore.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="../../../../../org/apache/openjpa/jdbc/kernel/JDBCSeq.html" title="interface in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/JDBCStore.html" target="_top">Frames</a></li>
<li><a href="JDBCStore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>