Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.1 / apidocs / org / apache / openjpa / jdbc / kernel / JDBCStore.html
blob: cb40cb7887324e9842f25e6d8fb610c5831fb5a1 [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 (version 1.7.0_79) on Mon Mar 21 21:59:42 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JDBCStore (OpenJPA Parent POM 2.4.1 API)</title>
<meta name="date" content="2016-03-21">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JDBCStore (OpenJPA Parent POM 2.4.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Next 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 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:&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="strong">JDBCStore</span></pre>
<div class="block">Represents the JDBC store.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.4.0</dd>
<dt><span class="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#find(java.lang.Object,%20org.apache.openjpa.jdbc.meta.ValueMapping,%20org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">find</a></strong>(<a href="http://download.oracle.com/javase/6/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 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getConfiguration()">getConfiguration</a></strong>()</code>
<div class="block">Return the configuration for this runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getConnection()">getConnection</a></strong>()</code>
<div class="block">Return a SQL connection to the database.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getContext()">getContext</a></strong>()</code>
<div class="block">Current persistence context.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getDBDictionary()">getDBDictionary</a></strong>()</code>
<div class="block">Return the dictionary in use.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getFetchConfiguration()">getFetchConfiguration</a></strong>()</code>
<div class="block">Return the current default fetch configuration.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getLockManager()">getLockManager</a></strong>()</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 class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getNewConnection()">getNewConnection</a></strong>()</code>
<div class="block">Return a new SQL connection to the database.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#getSQLFactory()">getSQLFactory</a></strong>()</code>
<div class="block">Return the SQL factory for this runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#loadSubclasses(org.apache.openjpa.jdbc.meta.ClassMapping)">loadSubclasses</a></strong>(<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 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><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html#newDataStoreId(long,%20org.apache.openjpa.jdbc.meta.ClassMapping,%20boolean)">newDataStoreId</a></strong>(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="http://download.oracle.com/javase/6/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="http://download.oracle.com/javase/6/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="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;find(<a href="http://download.oracle.com/javase/6/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="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Next 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 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:&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;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>