blob: dcbe4a9a459cca04e4511fc1685b32f318ed8b54 [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 (1.8.0_60) on Sat Jan 11 18:35:16 CET 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Persistent (JDO API 3.1)</title>
<meta name="date" content="2020-01-11">
<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="Persistent (JDO API 3.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/Persistent.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/PersistenceModifier.html" title="enum in javax.jdo.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/annotations/PrimaryKey.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/Persistent.html" target="_top">Frames</a></li>
<li><a href="Persistent.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 Persistent" class="title">Annotation Type Persistent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>})
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/1.5.0/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">Persistent</span></pre>
<div class="block">Annotation for defining the persistence of a member.
This corresponds to the xml elements "field" and "property".</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="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#cacheable--">cacheable</a></span></code>
<div class="block">Whether this field/property is cacheable in a Level2 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#column--">column</a></span></code>
<div class="block">Column name where the values are stored for this member.</div>
</td>
</tr>
<tr class="altColor">
<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/Persistent.html#columns--">columns</a></span></code>
<div class="block">Column definition(s) for this member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#customValueStrategy--">customValueStrategy</a></span></code>
<div class="block">Custom value strategy to use to generate the value for this field
or property (if any).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#defaultFetchGroup--">defaultFetchGroup</a></span></code>
<div class="block">Whether this member is in the default fetch group.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#dependent--">dependent</a></span></code>
<div class="block">Whether related object(s) of this member are dependent
and so deleted when this object is deleted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#dependentElement--">dependentElement</a></span></code>
<div class="block">Whether the elements of this member are dependent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#dependentKey--">dependentKey</a></span></code>
<div class="block">Whether the keys of this member are dependent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#dependentValue--">dependentValue</a></span></code>
<div class="block">Whether the values of this member are dependent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#embedded--">embedded</a></span></code>
<div class="block">Whether this member is embedded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#embeddedElement--">embeddedElement</a></span></code>
<div class="block">Whether the elements of this member are embedded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#embeddedKey--">embeddedKey</a></span></code>
<div class="block">Whether the keys of this member are embedded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#embeddedValue--">embeddedValue</a></span></code>
<div class="block">Whether the values of this member are embedded.</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/Persistent.html#extensions--">extensions</a></span></code>
<div class="block">Vendor extensions for this member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#loadFetchGroup--">loadFetchGroup</a></span></code>
<div class="block">Name of the fetch-group to use when this member is loaded
due to being referenced when not already loaded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#mappedBy--">mappedBy</a></span></code>
<div class="block">Name of the related member in the other class
where this value is mapped (bidirectional relationship).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#name--">name</a></span></code>
<div class="block">Name of the member when this is embedded in another object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#nullIndicatorColumn--">nullIndicatorColumn</a></span></code>
<div class="block">Null indicator column for this member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/NullValue.html" title="enum in javax.jdo.annotations">NullValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Persistent.html#nullValue--">nullValue</a></span></code>
<div class="block">Behavior when this member contains a null value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations">PersistenceModifier</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Persistent.html#persistenceModifier--">persistenceModifier</a></span></code>
<div class="block">Modifier for this field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#primaryKey--">primaryKey</a></span></code>
<div class="block">Whether this member is part of the primary key for application
identity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Persistent.html#recursionDepth--">recursionDepth</a></span></code>
<div class="block">Recursion depth for this member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#sequence--">sequence</a></span></code>
<div class="block">Name of the sequence to use with particular value strategies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#serialized--">serialized</a></span></code>
<div class="block">Whether this member is serialized into a single column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#serializedElement--">serializedElement</a></span></code>
<div class="block">Whether the elements of this member are serialized.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#serializedKey--">serializedKey</a></span></code>
<div class="block">Whether the keys of this member are serialized.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#serializedValue--">serializedValue</a></span></code>
<div class="block">Whether the values of this member are serialized.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#table--">table</a></span></code>
<div class="block">Table to use for persisting this member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/Persistent.html#types--">types</a></span></code>
<div class="block">Types of the member.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/annotations/IdGeneratorStrategy.html" title="enum in javax.jdo.annotations">IdGeneratorStrategy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/annotations/Persistent.html#valueStrategy--">valueStrategy</a></span></code>
<div class="block">Value strategy to use to generate the value for this field
or property (if any).</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="persistenceModifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>persistenceModifier</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations">PersistenceModifier</a>&nbsp;persistenceModifier</pre>
<div class="block">Modifier for this field. This is normally not specified, and the
defaults are used, or the @Transactional or @NotPersistent
annotation is specified directly on the member. One possible use
for specifying persistenceModifier is for embedded instances in which
a member is not persistent but in the non-embedded instances the
member is persistent. Note that it is not portable to specify a
member to be not persistent in the non-embedded case and persistent
in the embedded usage.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the persistence modifier</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>javax.jdo.annotations.PersistenceModifier.UNSPECIFIED</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table</pre>
<div class="block">Table to use for persisting this member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the table to use for persisting this member</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="defaultFetchGroup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultFetchGroup</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultFetchGroup</pre>
<div class="block">Whether this member is in the default fetch group.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this member is in the default fetch group</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nullValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullValue</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/NullValue.html" title="enum in javax.jdo.annotations">NullValue</a>&nbsp;nullValue</pre>
<div class="block">Behavior when this member contains a null value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the behavior when this member contains a null value</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>javax.jdo.annotations.NullValue.NONE</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="http://docs.oracle.com/javase/1.5.0/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 member is embedded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this member is embedded</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="embeddedElement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>embeddedElement</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;embeddedElement</pre>
<div class="block">Whether the elements of this member are embedded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the elements of this member are embedded</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="embeddedKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>embeddedKey</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;embeddedKey</pre>
<div class="block">Whether the keys of this member are embedded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the keys of this member are embedded</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="embeddedValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>embeddedValue</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;embeddedValue</pre>
<div class="block">Whether the values of this member are embedded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the values of this member are embedded</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="http://docs.oracle.com/javase/1.5.0/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 this member is serialized into a single column.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this member is serialized into a single column</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="serializedElement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializedElement</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serializedElement</pre>
<div class="block">Whether the elements of this member are serialized.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the elements of this member are serialized</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="serializedKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializedKey</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serializedKey</pre>
<div class="block">Whether the keys of this member are serialized.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the keys of this member are serialized</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="serializedValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializedValue</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serializedValue</pre>
<div class="block">Whether the values of this member are serialized.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the values of this member are serialized</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="http://docs.oracle.com/javase/1.5.0/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 related object(s) of this member are dependent
and so deleted when this object is deleted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the related object(s) of this member
are dependent</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="dependentElement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dependentElement</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dependentElement</pre>
<div class="block">Whether the elements of this member are dependent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the elements of this member are dependent</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="dependentKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dependentKey</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dependentKey</pre>
<div class="block">Whether the keys of this member are dependent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the keys of this member are dependent</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="dependentValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dependentValue</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dependentValue</pre>
<div class="block">Whether the values of this member are dependent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the values of this member are dependent</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="primaryKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>primaryKey</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;primaryKey</pre>
<div class="block">Whether this member is part of the primary key for application
identity. This is equivalent to specifying @PrimaryKey as
a separate annotation on the member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this member is part of the primary key</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="valueStrategy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueStrategy</h4>
<pre>public abstract&nbsp;<a href="../../../javax/jdo/annotations/IdGeneratorStrategy.html" title="enum in javax.jdo.annotations">IdGeneratorStrategy</a>&nbsp;valueStrategy</pre>
<div class="block">Value strategy to use to generate the value for this field
or property (if any).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the generated value strategy</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>javax.jdo.annotations.IdGeneratorStrategy.UNSPECIFIED</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="customValueStrategy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customValueStrategy</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;customValueStrategy</pre>
<div class="block">Custom value strategy to use to generate the value for this field
or property (if any). If customValueStrategy is non-empty, then
valueStrategy must be UNSPECIFIED.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the custom value strategy</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="sequence--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sequence</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sequence</pre>
<div class="block">Name of the sequence to use with particular value strategies.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the sequence</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="loadFetchGroup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadFetchGroup</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loadFetchGroup</pre>
<div class="block">Name of the fetch-group to use when this member is loaded
due to being referenced when not already loaded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the load fetch group</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="types--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>types</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/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 member. Used when the declared
member type is a supertype of the actual type that is stored in the
member. For example, the declared member type might be an interface type
that must contain an object of a concrete type when used
for persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the types</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="http://docs.oracle.com/javase/1.5.0/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 the related member in the other class
where this value is mapped (bidirectional relationship).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the related member in the other class</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">Column definition(s) for this member. Used for mapping
multiple columns
to the same member, for example relationships with
multiple column foreign keys.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the columns for this member</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;column</pre>
<div class="block">Column name where the values are stored for this member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the column</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nullIndicatorColumn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullIndicatorColumn</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nullIndicatorColumn</pre>
<div class="block">Null indicator column for this member. Used for nested
embedded fields or properties to indicate whether the embedded
instance should have a null value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the null indicator column</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name</pre>
<div class="block">Name of the member when this is embedded in another object.
The fully-qualified member name is used. For example,
"line.point1.x" refers to the member x in class Point
that is embedded as member point1 in class Line that is embedded
in a member called line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the member</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="recursionDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recursionDepth</h4>
<pre>public abstract&nbsp;int&nbsp;recursionDepth</pre>
<div class="block">Recursion depth for this member. Used only when
the annotation is used within the definition of a FetchGroup.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the recursion depth</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>1</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="cacheable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheable</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cacheable</pre>
<div class="block">Whether this field/property is cacheable in a Level2 cache.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"true"</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 for this member.</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/Persistent.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/PersistenceModifier.html" title="enum in javax.jdo.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/annotations/PrimaryKey.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/Persistent.html" target="_top">Frames</a></li>
<li><a href="Persistent.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;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>