blob: 9a753a82aa03daed8912167953922e020c59f2a0 [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_201) on Wed Apr 24 20:07:05 CEST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ValueHandler (OpenJPA Parent POM 3.1.0 API)</title>
<meta name="date" content="2019-04-24">
<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="ValueHandler (OpenJPA Parent POM 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/ValueHandler.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/StrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/ValueHandler.html" target="_top">Frames</a></li>
<li><a href="ValueHandler.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.meta</div>
<h2 title="Interface ValueHandler" class="title">Interface ValueHandler</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>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/BlobValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">BlobValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/ByteArrayValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ByteArrayValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/CharArrayStreamValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">CharArrayStreamValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/CharArrayValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">CharArrayValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/ClobValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ClobValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ElementEmbedValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">EmbedValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/EnumValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">EnumValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/ImmutableValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ImmutableValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/ObjectIdValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ObjectIdValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/UntypedPCValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">UntypedPCValueHandler</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/XMLValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">XMLValueHandler</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ValueHandler</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">Maps a value to a relational schema. Value handler are stateless.</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/meta/ValueHandler.html#getResultArgument-org.apache.openjpa.jdbc.meta.ValueMapping-">getResultArgument</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm)</code>
<div class="block">Return the argument to pass to the result set when loading data
via <a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html#getObject-java.lang.Object-int-java.lang.Object-"><code>Result.getObject(java.lang.Object, int, java.lang.Object)</code></a>, or null if none.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#isVersionable-org.apache.openjpa.jdbc.meta.ValueMapping-">isVersionable</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm)</code>
<div class="block">Return whether the values managed by this handler can be used in
state image versioning.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#map-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.String-org.apache.openjpa.jdbc.schema.ColumnIO-boolean-">map</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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>&nbsp;name,
<a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a>&nbsp;io,
boolean&nbsp;adapt)</code>
<div class="block">Map the given value and return all mapped columns, or simply return an
array of unmapped default columns.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#objectValueRequiresLoad-org.apache.openjpa.jdbc.meta.ValueMapping-">objectValueRequiresLoad</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm)</code>
<div class="block">Return whether this handler potentially must load extra data to extract
the object value from its datastore representation.</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="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toDataStoreValue-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.Object-org.apache.openjpa.jdbc.kernel.JDBCStore-">toDataStoreValue</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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;val,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store)</code>
<div class="block">Translate the given value to its datastore equivalent.</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="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toObjectValue-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.Object-">toObjectValue</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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;val)</code>
<div class="block">Translate the given datastore value into its Java equivalent.</div>
</td>
</tr>
<tr id="i6" 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/meta/ValueHandler.html#toObjectValue-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.Object-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-">toObjectValue</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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;val,
<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)</code>
<div class="block">Translate the given datastore value into its Java equivalent.</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="map-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.String-org.apache.openjpa.jdbc.schema.ColumnIO-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>map</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]&nbsp;map(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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>&nbsp;name,
<a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a>&nbsp;io,
boolean&nbsp;adapt)</pre>
<div class="block">Map the given value and return all mapped columns, or simply return an
array of unmapped default columns. The columns should have at least
their <code>Name</code> and <code>JavaType</code> properties set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - use as a base to form column name(s); the column names
of unmapped columns will automatically be made to fit
database limitations</dd>
<dd><code>io</code> - I/O information about mapped columns; you do not
have to set this information if returning templates</dd>
<dd><code>adapt</code> - whether to adapt the mapping or schema</dd>
</dl>
</li>
</ul>
<a name="isVersionable-org.apache.openjpa.jdbc.meta.ValueMapping-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVersionable</h4>
<pre>boolean&nbsp;isVersionable(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm)</pre>
<div class="block">Return whether the values managed by this handler can be used in
state image versioning.</div>
</li>
</ul>
<a name="objectValueRequiresLoad-org.apache.openjpa.jdbc.meta.ValueMapping-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>objectValueRequiresLoad</h4>
<pre>boolean&nbsp;objectValueRequiresLoad(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm)</pre>
<div class="block">Return whether this handler potentially must load extra data to extract
the object value from its datastore representation.</div>
</li>
</ul>
<a name="getResultArgument-org.apache.openjpa.jdbc.meta.ValueMapping-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultArgument</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;getResultArgument(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm)</pre>
<div class="block">Return the argument to pass to the result set when loading data
via <a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html#getObject-java.lang.Object-int-java.lang.Object-"><code>Result.getObject(java.lang.Object, int, java.lang.Object)</code></a>, or null if none. If this value
occupies multiple columns, return an array with one element per
column. You may return null if all array elements would be null.</div>
</li>
</ul>
<a name="toDataStoreValue-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.Object-org.apache.openjpa.jdbc.kernel.JDBCStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toDataStoreValue</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;toDataStoreValue(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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;val,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store)</pre>
<div class="block">Translate the given value to its datastore equivalent. If this value
occupies multiple columns, return an object array with one element
per column. For relation id columns, return the state manager
the column depends on.</div>
</li>
</ul>
<a name="toObjectValue-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toObjectValue</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;toObjectValue(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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;val)</pre>
<div class="block">Translate the given datastore value into its Java equivalent. If
the value occupies multiple columns, the given object will be an object
array with one entry per column. This method is only called if
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#objectValueRequiresLoad-org.apache.openjpa.jdbc.meta.ValueMapping-"><code>objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)</code></a> returns false.</div>
</li>
</ul>
<a name="toObjectValue-org.apache.openjpa.jdbc.meta.ValueMapping-java.lang.Object-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toObjectValue</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;toObjectValue(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</a>&nbsp;vm,
<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;val,
<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)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Translate the given datastore value into its Java equivalent. If
the value occupies multiple columns, the given object will be an object
array with one entry per column. This method is only called if
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#objectValueRequiresLoad-org.apache.openjpa.jdbc.meta.ValueMapping-"><code>objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)</code></a> returns true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sm</code> - the state manager that owns the value; may be null if
loading a projection</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/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>
<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/ValueHandler.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/StrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/ValueHandler.html" target="_top">Frames</a></li>
<li><a href="ValueHandler.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;2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>