Google Git
Sign in
apache / db-jdo-site / refs/heads/publish / . / content / api321 / apidocs / javax / jdo / annotations / Key.html
blob: 0420604a764112632b670a062410a766604da0bf [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Key (JDO API 3.2.1)</title>
<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="Key (JDO API 3.2.1)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<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/Key.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="../../../javax/jdo/annotations/Joins.html" title="annotation in javax.jdo.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/annotations/NotPersistent.html" title="annotation in javax.jdo.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/annotations/Key.html" target="_top">Frames</a></li>
<li><a href="Key.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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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">javax.jdo.annotations</div>
<h2 title="Annotation Type Key" class="title">Annotation Type Key</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>})
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
public @interface <span class="memberNameLabel">Key</span></pre>
<div class="block">Annotation for the key of a map relation.
Corresponds to the xml element "key".</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#column--">column</a></span></code>
<div class="block">Name of the column to store the key in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/Column.html" title="annotation in javax.jdo.annotations">Column</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#columns--">columns</a></span></code>
<div class="block">The column(s) for the key</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../javax/jdo/AttributeConverter.html" title="interface in javax.jdo">AttributeConverter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#converter--">converter</a></span></code>
<div class="block">Optional <a href="../../../javax/jdo/AttributeConverter.html" title="interface in javax.jdo"><code>AttributeConverter</code></a> to use for converting this key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#deleteAction--">deleteAction</a></span></code>
<div class="block">Delete action to apply to the foreign key for the key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#dependent--">dependent</a></span></code>
<div class="block">Whether the key is dependent on the owner (and will be deleted
when the owner is deleted).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#embedded--">embedded</a></span></code>
<div class="block">Whether this key is embedded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/Embedded.html" title="annotation in javax.jdo.annotations">Embedded</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#embeddedMapping--">embeddedMapping</a></span></code>
<div class="block">The embedded mapping for the key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#extensions--">extensions</a></span></code>
<div class="block">Vendor extensions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#foreignKey--">foreignKey</a></span></code>
<div class="block">Name for a generated foreign key constraint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#generateForeignKey--">generateForeignKey</a></span></code>
<div class="block">Generate or assume a foreign key constraint exists on the column
or columns associated with this join.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#index--">index</a></span></code>
<div class="block">The name of the index to generate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#indexed--">indexed</a></span></code>
<div class="block">Whether the value column(s) should be indexed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#mappedBy--">mappedBy</a></span></code>
<div class="block">Name of a member in the value class where this key is stored.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#serialized--">serialized</a></span></code>
<div class="block">Whether the key is to be stored serialized (into a single column of a
join table).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#table--">table</a></span></code>
<div class="block">Name of the table for the key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#types--">types</a></span></code>
<div class="block">Types of the keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#unique--">unique</a></span></code>
<div class="block">Whether the element column(s) contents should be considered unique</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#uniqueKey--">uniqueKey</a></span></code>
<div class="block">The name of the unique key constraint to generate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#updateAction--">updateAction</a></span></code>
<div class="block">Update action to apply to the foreign key for the key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Key.html#useDefaultConversion--">useDefaultConversion</a></span></code>
<div class="block">Whether we should disable any converter that was specified as default for this type on the PMF.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="types--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>types</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]&nbsp;types</pre>
<div class="block">Types of the keys. This can be determined if using JDK1.5 generics
but is required otherwise. Multiple types can be specified if the
implementation supports multiple types.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the types of keys</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="serialized--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialized</h4>
<pre>public abstract&nbsp;<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;serialized</pre>
<div class="block">Whether the key is to be stored serialized (into a single column of a
join table).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the key is to be stored serialized</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="embedded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>embedded</h4>
<pre>public abstract&nbsp;<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;embedded</pre>
<div class="block">Whether this key is embedded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this key is embedded</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="embeddedMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>embeddedMapping</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/Embedded.html" title="annotation in javax.jdo.annotations">Embedded</a>[]&nbsp;embeddedMapping</pre>
<div class="block">The embedded mapping for the key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the embedded mapping for the key</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="dependent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dependent</h4>
<pre>public abstract&nbsp;<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;dependent</pre>
<div class="block">Whether the key is dependent on the owner (and will be deleted
when the owner is deleted).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the key is dependent on the owner</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="table--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>table</h4>
<pre>public abstract&nbsp;<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;table</pre>
<div class="block">Name of the table for the key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name of the table for the key</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="column--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>column</h4>
<pre>public abstract&nbsp;<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;column</pre>
<div class="block">Name of the column to store the key in.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name of the column to store the key in</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="deleteAction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAction</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</a>&nbsp;deleteAction</pre>
<div class="block">Delete action to apply to the foreign key for the key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>delete action to apply to the foreign key for the key</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="updateAction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAction</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</a>&nbsp;updateAction</pre>
<div class="block">Update action to apply to the foreign key for the key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>update action to apply to the foreign key for the key</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="indexed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexed</h4>
<pre>public abstract&nbsp;<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;indexed</pre>
<div class="block">Whether the value column(s) should be indexed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the value column(s) should be indexed.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="index--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>index</h4>
<pre>public abstract&nbsp;<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;index</pre>
<div class="block">The name of the index to generate.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the index</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="unique--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unique</h4>
<pre>public abstract&nbsp;<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;unique</pre>
<div class="block">Whether the element column(s) contents should be considered unique</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the element column(s) contents should be considered unique</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="uniqueKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uniqueKey</h4>
<pre>public abstract&nbsp;<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;uniqueKey</pre>
<div class="block">The name of the unique key constraint to generate.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the unique key constraint</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="mappedBy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mappedBy</h4>
<pre>public abstract&nbsp;<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;mappedBy</pre>
<div class="block">Name of a member in the value class where this key is stored.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of a member in the value class where this key is stored</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="columns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columns</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/Column.html" title="annotation in javax.jdo.annotations">Column</a>[]&nbsp;columns</pre>
<div class="block">The column(s) for the key</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the column(s) for the key</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="generateForeignKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateForeignKey</h4>
<pre>public abstract&nbsp;<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;generateForeignKey</pre>
<div class="block">Generate or assume a foreign key constraint exists on the column
or columns associated with this join. Specify "true" or "false".</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to generate or assume a foreign key constraint</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="foreignKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>foreignKey</h4>
<pre>public abstract&nbsp;<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;foreignKey</pre>
<div class="block">Name for a generated foreign key constraint.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the generated foreign key constraint</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="converter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>converter</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../javax/jdo/AttributeConverter.html" title="interface in javax.jdo">AttributeConverter</a>&gt;&nbsp;converter</pre>
<div class="block">Optional <a href="../../../javax/jdo/AttributeConverter.html" title="interface in javax.jdo"><code>AttributeConverter</code></a> to use for converting this key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional converter class for converting this key (when non-PersistenceCapable)</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>javax.jdo.AttributeConverter.UseDefault.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="useDefaultConversion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useDefaultConversion</h4>
<pre>public abstract&nbsp;boolean&nbsp;useDefaultConversion</pre>
<div class="block">Whether we should disable any converter that was specified as default for this type on the PMF.
Only has any effect when this is explicitly set to true, when any AttributeConverter specified for this type
either here or for the class or at the PMF will be ignored and will use the JDO implementation default handling.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether PMF attribute conversion is to be disabled.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="extensions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>extensions</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</a>[]&nbsp;extensions</pre>
<div class="block">Vendor extensions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the vendor extensions</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</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/Key.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="../../../javax/jdo/annotations/Joins.html" title="annotation in javax.jdo.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/annotations/NotPersistent.html" title="annotation in javax.jdo.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/annotations/Key.html" target="_top">Frames</a></li>
<li><a href="Key.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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>