Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.1 / apidocs / org / apache / openjpa / jdbc / meta / ValueMapping.html
blob: 85c554792579e643336f9c7517ec25d6ca3a7d22 [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:44 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ValueMapping (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="ValueMapping (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/ValueMapping.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/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingImpl.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/ValueMapping.html" target="_top">Frames</a></li>
<li><a href="ValueMapping.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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 ValueMapping" class="title">Interface ValueMapping</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a>, <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/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingImpl.html" title="class in org.apache.openjpa.jdbc.meta">ValueMappingImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ValueMapping</span>
extends <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a>, <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></pre>
<div class="block">Specialization of value metadata for relational databases.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#JOIN_EXPECTED_INVERSE">JOIN_EXPECTED_INVERSE</a></strong></code>
<div class="block">Inverse join that is marked up as a forward join because the
backing mapping expects an inverse direction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#JOIN_FORWARD">JOIN_FORWARD</a></strong></code>
<div class="block">Standard forward join.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#JOIN_INVERSE">JOIN_INVERSE</a></strong></code>
<div class="block">Inverse join.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#POLY_FALSE">POLY_FALSE</a></strong></code>
<div class="block">A non-polymorphic relation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#POLY_JOINABLE">POLY_JOINABLE</a></strong></code>
<div class="block">A relation that can hold any joinable subclass type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#POLY_TRUE">POLY_TRUE</a></strong></code>
<div class="block">A fully polymorphic relation (the default).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.meta.ValueMetaData">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.meta.<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></h3>
<code><a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#CASCADE_AUTO">CASCADE_AUTO</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#CASCADE_IMMEDIATE">CASCADE_IMMEDIATE</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#CASCADE_NONE">CASCADE_NONE</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#MAPPED_BY_PK">MAPPED_BY_PK</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.meta.MetaDataModes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.meta.<a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></h3>
<code><a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ALL">MODE_ALL</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ANN_MAPPING">MODE_ANN_MAPPING</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING">MODE_MAPPING</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING_INIT">MODE_MAPPING_INIT</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_META">MODE_META</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_NONE">MODE_NONE</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_QUERY">MODE_QUERY</a></code></li>
</ul>
</li>
</ul>
<!-- ========== 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/meta/ValueMapping.html#clearMapping()">clearMapping</a></strong>()</code>
<div class="block">Clear mapping information, including strategy.</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/ValueMapping.html#copyMappingInfo(org.apache.openjpa.jdbc.meta.ValueMapping)">copyMappingInfo</a></strong>(<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">Copy mapping info from the given instance to this one.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getColumnIO()">getColumnIO</a></strong>()</code>
<div class="block">I/O information on the foreign key, or columns if this value doesn't
have a key.</div>
</td>
</tr>
<tr class="rowColor">
<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><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getColumns()">getColumns</a></strong>()</code>
<div class="block">The columns that hold the data for this value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getDeclaredTypeMapping()">getDeclaredTypeMapping</a></strong>()</code>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeMetaData()"><code>ValueMetaData.getDeclaredTypeMetaData()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getEmbeddedMapping()">getEmbeddedMapping</a></strong>()</code>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getEmbeddedMetaData()"><code>ValueMetaData.getEmbeddedMetaData()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getFieldMapping()">getFieldMapping</a></strong>()</code>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getFieldMetaData()"><code>ValueMetaData.getFieldMetaData()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getForeignKey()">getForeignKey</a></strong>()</code>
<div class="block">If this value joins to another record, the foreign key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getForeignKey(org.apache.openjpa.jdbc.meta.ClassMapping)">getForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;target)</code>
<div class="block">Return an equivalent of this value's foreign key, but joining to the
given target, which may be an unjoined subclass of this value's
related type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getHandler()">getHandler</a></strong>()</code>
<div class="block">The handler used for this value, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getIndependentTypeMappings()">getIndependentTypeMappings</a></strong>()</code>
<div class="block">Return all independently-mapped joinable types for this value, depending
on whether this value is polymorphic and how the related type is mapped.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getJoinDirection()">getJoinDirection</a></strong>()</code>
<div class="block">The join direction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getMappingRepository()">getMappingRepository</a></strong>()</code>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/MetaDataContext.html#getRepository()"><code>MetaDataContext.getRepository()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getPolymorphic()">getPolymorphic</a></strong>()</code>
<div class="block">The degree to which this relation is polymorphic.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getSelectSubclasses()">getSelectSubclasses</a></strong>()</code>
<div class="block">Return the <code>org.apache.openjpa.sql.Select</code> subclasses constant
for loading this relation, based on how the related type is mapped,
whether this relation is polymorphic, and whether it is configured to
use class criteria.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getTypeMapping()">getTypeMapping</a></strong>()</code>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeMetaData()"><code>ValueMetaData.getTypeMetaData()</code></a>.</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/ValueMapping.html#getUseClassCriteria()">getUseClassCriteria</a></strong>()</code>
<div class="block">Whether to use class criteria when joining to related type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getValueIndex()">getValueIndex</a></strong>()</code>
<div class="block">Index on this value's columns, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">ValueMappingInfo</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getValueInfo()">getValueInfo</a></strong>()</code>
<div class="block">Raw mapping data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getValueMappedByMapping()">getValueMappedByMapping</a></strong>()</code>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedByMetaData()"><code>ValueMetaData.getValueMappedByMetaData()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#getValueUnique()">getValueUnique</a></strong>()</code>
<div class="block">Unique constraint on this value's columns, or null if none.</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/ValueMapping.html#mapConstraints(org.apache.openjpa.jdbc.identifier.DBIdentifier,%20boolean)">mapConstraints</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a>&nbsp;name,
boolean&nbsp;adapt)</code>
<div class="block">Map indexes and constraints for this value, using the current
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><code>ValueMappingInfo</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#mapConstraints(java.lang.String,%20boolean)">mapConstraints</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
boolean&nbsp;adapt)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;&nbsp;</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/ValueMapping.html#refSchemaComponents()">refSchemaComponents</a></strong>()</code>
<div class="block">Increase the reference count on used schema components.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#setColumnIO(org.apache.openjpa.jdbc.schema.ColumnIO)">setColumnIO</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a>&nbsp;io)</code>
<div class="block">I/O information on the foreign key, or columns if this value doesn't
have a key.</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/ValueMapping.html#setColumns(org.apache.openjpa.jdbc.schema.Column[])">setColumns</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]&nbsp;cols)</code>
<div class="block">The columns that hold the data for this value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#setForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)">setForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a>&nbsp;fk)</code>
<div class="block">If this value joins to another record, the foreign key.</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/ValueMapping.html#setForeignKey(org.apache.openjpa.jdbc.sql.Row,%20org.apache.openjpa.kernel.OpenJPAStateManager)">setForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;rel)</code>
<div class="block">Sets this value's foreign key to the given related object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#setForeignKey(org.apache.openjpa.jdbc.sql.Row,%20org.apache.openjpa.kernel.OpenJPAStateManager,%20int)">setForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;rel,
int&nbsp;targetNumber)</code>
<div class="block">Sets this value's foreign key to the given related object.</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/ValueMapping.html#setHandler(org.apache.openjpa.jdbc.meta.ValueHandler)">setHandler</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</a>&nbsp;handler)</code>
<div class="block">The handler used for this value, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#setJoinDirection(int)">setJoinDirection</a></strong>(int&nbsp;direction)</code>
<div class="block">The join direction.</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/ValueMapping.html#setPolymorphic(int)">setPolymorphic</a></strong>(int&nbsp;polymorphic)</code>
<div class="block">The degree to which this relation is polymorphic.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#setUseClassCriteria(boolean)">setUseClassCriteria</a></strong>(boolean&nbsp;criteria)</code>
<div class="block">Whether to use class criteria when joining to related type.</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/ValueMapping.html#setValueIndex(org.apache.openjpa.jdbc.schema.Index)">setValueIndex</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</a>&nbsp;idx)</code>
<div class="block">Index on this value's columns, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#setValueUnique(org.apache.openjpa.jdbc.schema.Unique)">setValueUnique</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</a>&nbsp;unq)</code>
<div class="block">Unique constraint on this value's columns, or null if none.</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/ValueMapping.html#syncMappingInfo()">syncMappingInfo</a></strong>()</code>
<div class="block">Update <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><code>MappingInfo</code></a> with our current mapping information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html#whereForeignKey(org.apache.openjpa.jdbc.sql.Row,%20org.apache.openjpa.kernel.OpenJPAStateManager)">whereForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;rel)</code>
<div class="block">Sets this value's foreign key to the given related object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.meta.ValueMetaData">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.meta.<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></h3>
<code><a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData()">addEmbeddedMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData(int)">addEmbeddedMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#copy(org.apache.openjpa.meta.ValueMetaData)">copy</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeAttach()">getCascadeAttach</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDelete()">getCascadeDelete</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDetach()">getCascadeDetach</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()">getCascadePersist</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeRefresh()">getCascadeRefresh</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredType()">getDeclaredType</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeCode()">getDeclaredTypeCode</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeMetaData()">getDeclaredTypeMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getEmbeddedMetaData()">getEmbeddedMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getFieldMetaData()">getFieldMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getResolve()">getResolve</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getType()">getType</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeCode()">getTypeCode</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeMetaData()">getTypeMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeOverride()">getTypeOverride</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedBy()">getValueMappedBy</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedByMetaData()">getValueMappedByMetaData</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#isDeclaredTypePC()">isDeclaredTypePC</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbedded()">isEmbedded</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbeddedPC()">isEmbeddedPC</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#isSerialized()">isSerialized</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#isTypePC()">isTypePC</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#resolve(int)">resolve</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeAttach(int)">setCascadeAttach</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDelete(int)">setCascadeDelete</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDetach(int)">setCascadeDetach</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int)">setCascadePersist</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int,%20boolean)">setCascadePersist</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeRefresh(int)">setCascadeRefresh</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredType(java.lang.Class)">setDeclaredType</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredTypeCode(int)">setDeclaredTypeCode</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setEmbedded(boolean)">setEmbedded</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setResolve(int)">setResolve</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setResolve(int,%20boolean)">setResolve</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setSerialized(boolean)">setSerialized</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setType(java.lang.Class)">setType</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeCode(int)">setTypeCode</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeOverride(java.lang.Class)">setTypeOverride</a>, <a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#setValueMappedBy(java.lang.String)">setValueMappedBy</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.meta.MetaDataContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.meta.<a href="../../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a></h3>
<code><a href="../../../../../org/apache/openjpa/meta/MetaDataContext.html#getRepository()">getRepository</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JOIN_FORWARD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOIN_FORWARD</h4>
<pre>static final&nbsp;int JOIN_FORWARD</pre>
<div class="block">Standard forward join.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ValueMapping.JOIN_FORWARD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JOIN_INVERSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOIN_INVERSE</h4>
<pre>static final&nbsp;int JOIN_INVERSE</pre>
<div class="block">Inverse join.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ValueMapping.JOIN_INVERSE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JOIN_EXPECTED_INVERSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOIN_EXPECTED_INVERSE</h4>
<pre>static final&nbsp;int JOIN_EXPECTED_INVERSE</pre>
<div class="block">Inverse join that is marked up as a forward join because the
backing mapping expects an inverse direction.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ValueMapping.JOIN_EXPECTED_INVERSE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="POLY_TRUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>POLY_TRUE</h4>
<pre>static final&nbsp;int POLY_TRUE</pre>
<div class="block">A fully polymorphic relation (the default).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ValueMapping.POLY_TRUE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="POLY_FALSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>POLY_FALSE</h4>
<pre>static final&nbsp;int POLY_FALSE</pre>
<div class="block">A non-polymorphic relation.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ValueMapping.POLY_FALSE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="POLY_JOINABLE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>POLY_JOINABLE</h4>
<pre>static final&nbsp;int POLY_JOINABLE</pre>
<div class="block">A relation that can hold any joinable subclass type.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ValueMapping.POLY_JOINABLE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getValueInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueInfo</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta">ValueMappingInfo</a>&nbsp;getValueInfo()</pre>
<div class="block">Raw mapping data.</div>
</li>
</ul>
<a name="getHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandler</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</a>&nbsp;getHandler()</pre>
<div class="block">The handler used for this value, or null if none.</div>
</li>
</ul>
<a name="setHandler(org.apache.openjpa.jdbc.meta.ValueHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHandler</h4>
<pre>void&nbsp;setHandler(<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</a>&nbsp;handler)</pre>
<div class="block">The handler used for this value, or null if none.</div>
</li>
</ul>
<a name="getMappingRepository()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMappingRepository</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a>&nbsp;getMappingRepository()</pre>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/MetaDataContext.html#getRepository()"><code>MetaDataContext.getRepository()</code></a>.</div>
</li>
</ul>
<a name="getFieldMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldMapping</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a>&nbsp;getFieldMapping()</pre>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getFieldMetaData()"><code>ValueMetaData.getFieldMetaData()</code></a>.</div>
</li>
</ul>
<a name="getTypeMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeMapping</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;getTypeMapping()</pre>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeMetaData()"><code>ValueMetaData.getTypeMetaData()</code></a>.</div>
</li>
</ul>
<a name="getDeclaredTypeMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredTypeMapping</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;getDeclaredTypeMapping()</pre>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeMetaData()"><code>ValueMetaData.getDeclaredTypeMetaData()</code></a>.</div>
</li>
</ul>
<a name="getEmbeddedMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmbeddedMapping</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;getEmbeddedMapping()</pre>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getEmbeddedMetaData()"><code>ValueMetaData.getEmbeddedMetaData()</code></a>.</div>
</li>
</ul>
<a name="getValueMappedByMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueMappedByMapping</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a>&nbsp;getValueMappedByMapping()</pre>
<div class="block">Convenience method to perform cast from
<a href="../../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedByMetaData()"><code>ValueMetaData.getValueMappedByMetaData()</code></a>.</div>
</li>
</ul>
<a name="getColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumns</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]&nbsp;getColumns()</pre>
<div class="block">The columns that hold the data for this value.</div>
</li>
</ul>
<a name="setColumns(org.apache.openjpa.jdbc.schema.Column[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumns</h4>
<pre>void&nbsp;setColumns(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]&nbsp;cols)</pre>
<div class="block">The columns that hold the data for this value.</div>
</li>
</ul>
<a name="getColumnIO()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnIO</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a>&nbsp;getColumnIO()</pre>
<div class="block">I/O information on the foreign key, or columns if this value doesn't
have a key.</div>
</li>
</ul>
<a name="setColumnIO(org.apache.openjpa.jdbc.schema.ColumnIO)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnIO</h4>
<pre>void&nbsp;setColumnIO(<a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a>&nbsp;io)</pre>
<div class="block">I/O information on the foreign key, or columns if this value doesn't
have a key.</div>
</li>
</ul>
<a name="getForeignKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeignKey</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a>&nbsp;getForeignKey()</pre>
<div class="block">If this value joins to another record, the foreign key.</div>
</li>
</ul>
<a name="getForeignKey(org.apache.openjpa.jdbc.meta.ClassMapping)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeignKey</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a>&nbsp;getForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;target)</pre>
<div class="block">Return an equivalent of this value's foreign key, but joining to the
given target, which may be an unjoined subclass of this value's
related type.</div>
</li>
</ul>
<a name="setForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignKey</h4>
<pre>void&nbsp;setForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a>&nbsp;fk)</pre>
<div class="block">If this value joins to another record, the foreign key.</div>
</li>
</ul>
<a name="getJoinDirection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoinDirection</h4>
<pre>int&nbsp;getJoinDirection()</pre>
<div class="block">The join direction.</div>
</li>
</ul>
<a name="setJoinDirection(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJoinDirection</h4>
<pre>void&nbsp;setJoinDirection(int&nbsp;direction)</pre>
<div class="block">The join direction.</div>
</li>
</ul>
<a name="setForeignKey(org.apache.openjpa.jdbc.sql.Row, org.apache.openjpa.kernel.OpenJPAStateManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignKey</h4>
<pre>void&nbsp;setForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;rel)
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">Sets this value's foreign key to the given related object. The object
may be null.</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="setForeignKey(org.apache.openjpa.jdbc.sql.Row, org.apache.openjpa.kernel.OpenJPAStateManager, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignKey</h4>
<pre>void&nbsp;setForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;rel,
int&nbsp;targetNumber)
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">Sets this value's foreign key to the given related object. The object
may be null. If the object is one of2or more foreign keys with the
same target, the targetNumber specifies the one to set.</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="whereForeignKey(org.apache.openjpa.jdbc.sql.Row, org.apache.openjpa.kernel.OpenJPAStateManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>whereForeignKey</h4>
<pre>void&nbsp;whereForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</a>&nbsp;row,
<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;rel)
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">Sets this value's foreign key to the given related object. The object
may be null.</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="getIndependentTypeMappings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndependentTypeMappings</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>[]&nbsp;getIndependentTypeMappings()</pre>
<div class="block">Return all independently-mapped joinable types for this value, depending
on whether this value is polymorphic and how the related type is mapped.
Return an empty array if value type is not PC.</div>
</li>
</ul>
<a name="getSelectSubclasses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectSubclasses</h4>
<pre>int&nbsp;getSelectSubclasses()</pre>
<div class="block">Return the <code>org.apache.openjpa.sql.Select</code> subclasses constant
for loading this relation, based on how the related type is mapped,
whether this relation is polymorphic, and whether it is configured to
use class criteria.</div>
</li>
</ul>
<a name="getValueUnique()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueUnique</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</a>&nbsp;getValueUnique()</pre>
<div class="block">Unique constraint on this value's columns, or null if none.</div>
</li>
</ul>
<a name="setValueUnique(org.apache.openjpa.jdbc.schema.Unique)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValueUnique</h4>
<pre>void&nbsp;setValueUnique(<a href="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</a>&nbsp;unq)</pre>
<div class="block">Unique constraint on this value's columns, or null if none.</div>
</li>
</ul>
<a name="getValueIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueIndex</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</a>&nbsp;getValueIndex()</pre>
<div class="block">Index on this value's columns, or null if none.</div>
</li>
</ul>
<a name="setValueIndex(org.apache.openjpa.jdbc.schema.Index)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValueIndex</h4>
<pre>void&nbsp;setValueIndex(<a href="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</a>&nbsp;idx)</pre>
<div class="block">Index on this value's columns, or null if none.</div>
</li>
</ul>
<a name="getUseClassCriteria()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUseClassCriteria</h4>
<pre>boolean&nbsp;getUseClassCriteria()</pre>
<div class="block">Whether to use class criteria when joining to related type.</div>
</li>
</ul>
<a name="setUseClassCriteria(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseClassCriteria</h4>
<pre>void&nbsp;setUseClassCriteria(boolean&nbsp;criteria)</pre>
<div class="block">Whether to use class criteria when joining to related type.</div>
</li>
</ul>
<a name="getPolymorphic()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolymorphic</h4>
<pre>int&nbsp;getPolymorphic()</pre>
<div class="block">The degree to which this relation is polymorphic.</div>
</li>
</ul>
<a name="setPolymorphic(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPolymorphic</h4>
<pre>void&nbsp;setPolymorphic(int&nbsp;polymorphic)</pre>
<div class="block">The degree to which this relation is polymorphic.</div>
</li>
</ul>
<a name="refSchemaComponents()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refSchemaComponents</h4>
<pre>void&nbsp;refSchemaComponents()</pre>
<div class="block">Increase the reference count on used schema components.</div>
</li>
</ul>
<a name="mapConstraints(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapConstraints</h4>
<pre>void&nbsp;mapConstraints(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
boolean&nbsp;adapt)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i></i></div>
<div class="block">Map indexes and constraints for this value, using the current
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><code>ValueMappingInfo</code></a>. The foreign key or columns of this value
must be set before calling this method.</div>
</li>
</ul>
<a name="mapConstraints(org.apache.openjpa.jdbc.identifier.DBIdentifier, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapConstraints</h4>
<pre>void&nbsp;mapConstraints(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a>&nbsp;name,
boolean&nbsp;adapt)</pre>
<div class="block">Map indexes and constraints for this value, using the current
<a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><code>ValueMappingInfo</code></a>. The foreign key or columns of this value
must be set before calling this method.</div>
</li>
</ul>
<a name="clearMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearMapping</h4>
<pre>void&nbsp;clearMapping()</pre>
<div class="block">Clear mapping information, including strategy.</div>
</li>
</ul>
<a name="syncMappingInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>syncMappingInfo</h4>
<pre>void&nbsp;syncMappingInfo()</pre>
<div class="block">Update <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingInfo.html" title="class in org.apache.openjpa.jdbc.meta"><code>MappingInfo</code></a> with our current mapping information.</div>
</li>
</ul>
<a name="copyMappingInfo(org.apache.openjpa.jdbc.meta.ValueMapping)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyMappingInfo</h4>
<pre>void&nbsp;copyMappingInfo(<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">Copy mapping info from the given instance to this one.</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/ValueMapping.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/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/ValueMappingImpl.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/ValueMapping.html" target="_top">Frames</a></li>
<li><a href="ValueMapping.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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>