blob: 671d35a05f68319b06ea9b08c2f3e4e8cc830e50 [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:43 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClassStrategy (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="ClassStrategy (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/ClassStrategy.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/meta/ClassMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/DelegatingJoinable.html" title="class in org.apache.openjpa.jdbc.meta"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/ClassStrategy.html" target="_top">Frames</a></li>
<li><a href="ClassStrategy.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.meta</div>
<h2 title="Interface ClassStrategy" class="title">Interface ClassStrategy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html" title="interface in org.apache.openjpa.jdbc.meta">Strategy</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractClassStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/EmbeddedClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">EmbeddedClassStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/FlatClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">FlatClassStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/FullClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">FullClassStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/NoneClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">NoneClassStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/ObjectIdClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">ObjectIdClassStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/VerticalClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">VerticalClassStrategy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ClassStrategy</span>
extends <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html" title="interface in org.apache.openjpa.jdbc.meta">Strategy</a></pre>
<div class="block">Mapping from a class to a relational schema.</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="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#customLoad(org.apache.openjpa.jdbc.kernel.JDBCStore,%20boolean,%20org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration,%20long,%20long)">customLoad</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
boolean&nbsp;subclasses,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
long&nbsp;startIdx,
long&nbsp;endIdx)</code>
<div class="block">Implement this method to customize obtaining a result containing all
instances of this class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#customLoad(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration,%20org.apache.openjpa.jdbc.sql.Result)">customLoad</a></strong>(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
<a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql">Result</a>&nbsp;result)</code>
<div class="block">Implement this method to customize loading from a <a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql"><code>Result</code></a>
into an instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#customLoad(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.kernel.PCState,%20org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">customLoad</a></strong>(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a>&nbsp;state,
<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">Implement this method to load the state of a given object, without
a previous <a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql"><code>Result</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#isPrimaryKeyObjectId(boolean)">isPrimaryKeyObjectId</a></strong>(boolean&nbsp;hasAll)</code>
<div class="block">Return true if the this class' primary key columns correspond to the
base class' primary key columns used to construct oid values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/Joins.html" title="interface in org.apache.openjpa.jdbc.sql">Joins</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#joinSuperclass(org.apache.openjpa.jdbc.sql.Joins,%20boolean)">joinSuperclass</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Joins.html" title="interface in org.apache.openjpa.jdbc.sql">Joins</a>&nbsp;joins,
boolean&nbsp;toThis)</code>
<div class="block">Join the mapping and its superclass.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#setClassMapping(org.apache.openjpa.jdbc.meta.ClassMapping)">setClassMapping</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;owner)</code>
<div class="block">Set the class mapping using this strategy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassStrategy.html#supportsEagerSelect(org.apache.openjpa.jdbc.sql.Select,%20org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.jdbc.meta.ClassMapping,%20org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">supportsEagerSelect</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Select.html" title="interface in org.apache.openjpa.jdbc.sql">Select</a>&nbsp;sel,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;base,
<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">Return true if this strategy can perform the given select from
the given <code>base</code> mapping.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.jdbc.meta.Strategy">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.jdbc.meta.<a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html" title="interface in org.apache.openjpa.jdbc.meta">Strategy</a></h3>
<code><a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#customDelete(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore)">customDelete</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#customInsert(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore)">customInsert</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#customUpdate(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore)">customUpdate</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#delete(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.jdbc.sql.RowManager)">delete</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#getAlias()">getAlias</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#initialize()">initialize</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#insert(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.jdbc.sql.RowManager)">insert</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#isCustomDelete(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore)">isCustomDelete</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#isCustomInsert(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore)">isCustomInsert</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#isCustomUpdate(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore)">isCustomUpdate</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#map(boolean)">map</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/Strategy.html#update(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.jdbc.sql.RowManager)">update</a></code></li>
</ul>
</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="setClassMapping(org.apache.openjpa.jdbc.meta.ClassMapping)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClassMapping</h4>
<pre>void&nbsp;setClassMapping(<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;owner)</pre>
<div class="block">Set the class mapping using this strategy. This will be called before
use.</div>
</li>
</ul>
<a name="isPrimaryKeyObjectId(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrimaryKeyObjectId</h4>
<pre>boolean&nbsp;isPrimaryKeyObjectId(boolean&nbsp;hasAll)</pre>
<div class="block">Return true if the this class' primary key columns correspond to the
base class' primary key columns used to construct oid values. Base
classes always return true. Classes that join to the base class table,
though, may not always join using the same columns the base class
uses for oid values, or may not use all the columns. When performing a
select, we will join down to the most-derived class that is identified
by oid values. We cannot use non-primary key field values for joining
during selects, because the field values to join on might be the ones
we're trying to select! Similarly, we can only reconstruct oid values
for selected objects using classes whose primary keys store oid values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hasAll</code> - if true, there must be a primary key column for every
base class primary key column; if false the primary key
must only match a subset of the base class primary key columns</dd></dl>
</li>
</ul>
<a name="joinSuperclass(org.apache.openjpa.jdbc.sql.Joins, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinSuperclass</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/sql/Joins.html" title="interface in org.apache.openjpa.jdbc.sql">Joins</a>&nbsp;joinSuperclass(<a href="../../../../../org/apache/openjpa/jdbc/sql/Joins.html" title="interface in org.apache.openjpa.jdbc.sql">Joins</a>&nbsp;joins,
boolean&nbsp;toThis)</pre>
<div class="block">Join the mapping and its superclass.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>toThis</code> - if false, inner join to the superclass table; if
true, outer join from the superclass table to this table</dd></dl>
</li>
</ul>
<a name="supportsEagerSelect(org.apache.openjpa.jdbc.sql.Select, org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsEagerSelect</h4>
<pre>boolean&nbsp;supportsEagerSelect(<a href="../../../../../org/apache/openjpa/jdbc/sql/Select.html" title="interface in org.apache.openjpa.jdbc.sql">Select</a>&nbsp;sel,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;base,
<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">Return true if this strategy can perform the given select from
the given <code>base</code> mapping.
The given state manager may be null if selecting multiple instances.</div>
</li>
</ul>
<a name="customLoad(org.apache.openjpa.jdbc.kernel.JDBCStore, boolean, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customLoad</h4>
<pre><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a>&nbsp;customLoad(<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
boolean&nbsp;subclasses,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
long&nbsp;startIdx,
long&nbsp;endIdx)
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">Implement this method to customize obtaining a result containing all
instances of this class. Return null for standard loading.</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="customLoad(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.kernel.PCState, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customLoad</h4>
<pre>boolean&nbsp;customLoad(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a>&nbsp;state,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch)
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>,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre>
<div class="block">Implement this method to load the state of a given object, without
a previous <a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql"><code>Result</code></a>. Return true if this method handles the
load. If the object does not exist in the data store, simply take no
action on it (but still return true). Return false to use default
loading.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - if non-null, then you must initialize the state
and persistent object of the given state manager
(after determining the actual class of the object
from the database, if there are possible persistent
subclasses); initialization looks like this: <code>
sm.initialize (pcClass, state)</code></dd>
<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>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code></dd></dl>
</li>
</ul>
<a name="customLoad(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, org.apache.openjpa.jdbc.sql.Result)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>customLoad</h4>
<pre>boolean&nbsp;customLoad(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
<a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql">Result</a>&nbsp;result)
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">Implement this method to customize loading from a <a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql"><code>Result</code></a>
into an instance. Return true if this mapping handles the
load; false if normal loading should proceed after calling this method.</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/ClassStrategy.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/meta/ClassMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/DelegatingJoinable.html" title="class in org.apache.openjpa.jdbc.meta"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/ClassStrategy.html" target="_top">Frames</a></li>
<li><a href="ClassStrategy.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>