Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / jdbc / sql / RowManager.html
blob: 7808e79e67614d95ce53f87332be07a50830631d [file] [log] [blame]
<!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 (version 1.7.0_121) on Fri Jan 06 19:36:30 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RowManager (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RowManager (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</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/RowManager.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/sql/RowImpl.html" title="class in org.apache.openjpa.jdbc.sql"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManagerImpl.html" title="class in org.apache.openjpa.jdbc.sql"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/sql/RowManager.html" target="_top">Frames</a></li>
<li><a href="RowManager.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.sql</div>
<h2 title="Interface RowManager" class="title">Interface RowManager</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/sql/RowManagerImpl.html" title="class in org.apache.openjpa.jdbc.sql">RowManagerImpl</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/StateComparisonVersionStrategy.CustomUpdate.html" title="class in org.apache.openjpa.jdbc.meta.strats">StateComparisonVersionStrategy.CustomUpdate</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">RowManager</span></pre>
<div class="block">Manages rows during an insert/update/delete process. Row managers
do not have to be threadsafe.</div>
<dl><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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#flushAllRows(org.apache.openjpa.jdbc.sql.Row)">flushAllRows</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row)</code>
<div class="block">Flush the logical row.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#flushSecondaryRow(org.apache.openjpa.jdbc.sql.Row)">flushSecondaryRow</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row)</code>
<div class="block">Flush the secondary row; after flushing the row is available for reuse.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#getAllRows(org.apache.openjpa.jdbc.schema.Table,%20int)">getAllRows</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table,
int&nbsp;action)</code>
<div class="block">Return a logical row representing an update that should be made to
all rows of the given table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#getRow(org.apache.openjpa.jdbc.schema.Table,%20int,%20org.apache.openjpa.kernel.OpenJPAStateManager,%20boolean)">getRow</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table,
int&nbsp;action,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
boolean&nbsp;create)</code>
<div class="block">Return the row for the given table and owner object, or null if
<code>create</code> is false and the row has not already been created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#getSecondaryRow(org.apache.openjpa.jdbc.schema.Table,%20int)">getSecondaryRow</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table,
int&nbsp;action)</code>
<div class="block">Return a row for the given secondary table.</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="getRow(org.apache.openjpa.jdbc.schema.Table, int, org.apache.openjpa.kernel.OpenJPAStateManager, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRow</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;getRow(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table,
int&nbsp;action,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
boolean&nbsp;create)</pre>
<div class="block">Return the row for the given table and owner object, or null if
<code>create</code> is false and the row has not already been created.
The action must be one of <a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_INSERT"><code>Row.ACTION_INSERT</code></a>,
<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_UPDATE"><code>Row.ACTION_UPDATE</code></a>, <a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_DELETE"><code>Row.ACTION_DELETE</code></a>.</div>
</li>
</ul>
<a name="getSecondaryRow(org.apache.openjpa.jdbc.schema.Table, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecondaryRow</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;getSecondaryRow(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table,
int&nbsp;action)</pre>
<div class="block">Return a row for the given secondary table.
The action must be one of <a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_INSERT"><code>Row.ACTION_INSERT</code></a>,
<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_UPDATE"><code>Row.ACTION_UPDATE</code></a>, <a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_DELETE"><code>Row.ACTION_DELETE</code></a>.
Note that secondary rows are not considered when creating the foreign
key dependency graph, with can cause constraint violations when using
the <code>UPDATE</code> action. Only use this action if the secondary
row does not have restrict-action foreign keys. Otherwise use both
a delete and then an insert to perform the update.</div>
</li>
</ul>
<a name="flushSecondaryRow(org.apache.openjpa.jdbc.sql.Row)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushSecondaryRow</h4>
<pre>void&nbsp;flushSecondaryRow(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Flush the secondary row; after flushing the row is available for reuse.
It will retain all previously set values.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd></dl>
</li>
</ul>
<a name="getAllRows(org.apache.openjpa.jdbc.schema.Table, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllRows</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;getAllRows(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table,
int&nbsp;action)</pre>
<div class="block">Return a logical row representing an update that should be made to
all rows of the given table. The action must be one of
<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_UPDATE"><code>Row.ACTION_UPDATE</code></a>, <a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_DELETE"><code>Row.ACTION_DELETE</code></a>.</div>
</li>
</ul>
<a name="flushAllRows(org.apache.openjpa.jdbc.sql.Row)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>flushAllRows</h4>
<pre>void&nbsp;flushAllRows(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Flush the logical row.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></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><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/RowManager.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/sql/RowImpl.html" title="class in org.apache.openjpa.jdbc.sql"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/sql/RowManagerImpl.html" title="class in org.apache.openjpa.jdbc.sql"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/sql/RowManager.html" target="_top">Frames</a></li>
<li><a href="RowManager.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;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>