blob: daf7639e03ef67ebe2dea750cd8dda9915243261 [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>javax.jdo.annotations (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="javax.jdo.annotations (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../javax/jdo/datastore/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/annotations/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;javax.jdo.annotations</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/DiscriminatorStrategy.html" title="enum in javax.jdo.annotations">DiscriminatorStrategy</a></td>
<td class="colLast">
<div class="block">Enumeration of the discriminator strategy values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</a></td>
<td class="colLast">
<div class="block">Enumeration of the foreign-key delete/update action values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/IdentityType.html" title="enum in javax.jdo.annotations">IdentityType</a></td>
<td class="colLast">
<div class="block">Enumeration of the identity type values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/IdGeneratorStrategy.html" title="enum in javax.jdo.annotations">IdGeneratorStrategy</a></td>
<td class="colLast">
<div class="block">Enumeration of the id generator strategy values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/InheritanceStrategy.html" title="enum in javax.jdo.annotations">InheritanceStrategy</a></td>
<td class="colLast">
<div class="block">Enumeration of the inheritance strategy values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/NullValue.html" title="enum in javax.jdo.annotations">NullValue</a></td>
<td class="colLast">
<div class="block">Enumeration of the "null-value" behavior values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations">PersistenceModifier</a></td>
<td class="colLast">
<div class="block">Enumeration of the persistence-modifier values for a field or property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/SequenceStrategy.html" title="enum in javax.jdo.annotations">SequenceStrategy</a></td>
<td class="colLast">
<div class="block">Enumeration of the sequence strategy values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/VersionStrategy.html" title="enum in javax.jdo.annotations">VersionStrategy</a></td>
<td class="colLast">
<div class="block">Enumeration of the version strategy values.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Cacheable.html" title="annotation in javax.jdo.annotations">Cacheable</a></td>
<td class="colLast">
<div class="block">Annotation to specify that this class/field/property is cacheable
in a Level 2 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Column.html" title="annotation in javax.jdo.annotations">Column</a></td>
<td class="colLast">
<div class="block">Annotation for a column in the database.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Columns.html" title="annotation in javax.jdo.annotations">Columns</a></td>
<td class="colLast">
<div class="block">Annotation for a group of columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Convert.html" title="annotation in javax.jdo.annotations">Convert</a></td>
<td class="colLast">
<div class="block">Specifies that a given type should be converted before being stored to, and after being retrieved from
the datastore using the given <a href="../../../javax/jdo/AttributeConverter.html" title="interface in javax.jdo"><code>AttributeConverter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/DatastoreIdentity.html" title="annotation in javax.jdo.annotations">DatastoreIdentity</a></td>
<td class="colLast">
<div class="block">Annotation for the datastore identity of the class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Discriminator.html" title="annotation in javax.jdo.annotations">Discriminator</a></td>
<td class="colLast">
<div class="block">Annotation for the discriminator of the class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Element.html" title="annotation in javax.jdo.annotations">Element</a></td>
<td class="colLast">
<div class="block">Annotation for the element of a collection/array relation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Embedded.html" title="annotation in javax.jdo.annotations">Embedded</a></td>
<td class="colLast">
<div class="block">Annotation to define that the object is embedded into the table of the
owning object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/EmbeddedOnly.html" title="annotation in javax.jdo.annotations">EmbeddedOnly</a></td>
<td class="colLast">
<div class="block">Annotation for whether the class is only for persisting embedded into
another object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</a></td>
<td class="colLast">
<div class="block">Annotation for a JDO vendor extension.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Extensions.html" title="annotation in javax.jdo.annotations">Extensions</a></td>
<td class="colLast">
<div class="block">Annotation for a group of extensions</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/FetchGroup.html" title="annotation in javax.jdo.annotations">FetchGroup</a></td>
<td class="colLast">
<div class="block">Annotation for the fetch group of a class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/FetchGroups.html" title="annotation in javax.jdo.annotations">FetchGroups</a></td>
<td class="colLast">
<div class="block">Annotation for a group of fetch-group objects</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/FetchPlan.html" title="annotation in javax.jdo.annotations">FetchPlan</a></td>
<td class="colLast">
<div class="block">Annotation for the fetch plan of a persistence manager, query, or extent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/FetchPlans.html" title="annotation in javax.jdo.annotations">FetchPlans</a></td>
<td class="colLast">
<div class="block">Annotation for a group of FetchPlan objects</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/ForeignKey.html" title="annotation in javax.jdo.annotations">ForeignKey</a></td>
<td class="colLast">
<div class="block">Annotation for a database foreign-key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/ForeignKeys.html" title="annotation in javax.jdo.annotations">ForeignKeys</a></td>
<td class="colLast">
<div class="block">Annotation for a group of foreign-key constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Index.html" title="annotation in javax.jdo.annotations">Index</a></td>
<td class="colLast">
<div class="block">Annotation for a database index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Indices.html" title="annotation in javax.jdo.annotations">Indices</a></td>
<td class="colLast">
<div class="block">Annotation for a group of index constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Inheritance.html" title="annotation in javax.jdo.annotations">Inheritance</a></td>
<td class="colLast">
<div class="block">Annotation for the inheritance of the class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Join.html" title="annotation in javax.jdo.annotations">Join</a></td>
<td class="colLast">
<div class="block">Annotation for the join of a relation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Joins.html" title="annotation in javax.jdo.annotations">Joins</a></td>
<td class="colLast">
<div class="block">Annotation for a group of joins.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Key.html" title="annotation in javax.jdo.annotations">Key</a></td>
<td class="colLast">
<div class="block">Annotation for the key of a map relation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/NotPersistent.html" title="annotation in javax.jdo.annotations">NotPersistent</a></td>
<td class="colLast">
<div class="block">Annotation to specify that the member is not persistent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Order.html" title="annotation in javax.jdo.annotations">Order</a></td>
<td class="colLast">
<div class="block">Annotation for the ordering component of an ordered container member,
such as Java Collections Framework Array and List types and Java native
array types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/PersistenceAware.html" title="annotation in javax.jdo.annotations">PersistenceAware</a></td>
<td class="colLast">
<div class="block">Annotation to specify that the class is persistence-aware.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/PersistenceCapable.html" title="annotation in javax.jdo.annotations">PersistenceCapable</a></td>
<td class="colLast">
<div class="block">Annotation for whether the class or interface is persistence-capable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Persistent.html" title="annotation in javax.jdo.annotations">Persistent</a></td>
<td class="colLast">
<div class="block">Annotation for defining the persistence of a member.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/PrimaryKey.html" title="annotation in javax.jdo.annotations">PrimaryKey</a></td>
<td class="colLast">
<div class="block">Annotation on a member to define it as a primary key member of a class or
persistent interface using application identity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Queries.html" title="annotation in javax.jdo.annotations">Queries</a></td>
<td class="colLast">
<div class="block">Annotation for a group of named queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Query.html" title="annotation in javax.jdo.annotations">Query</a></td>
<td class="colLast">
<div class="block">Annotation for a named query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Sequence.html" title="annotation in javax.jdo.annotations">Sequence</a></td>
<td class="colLast">
<div class="block">Annotation for a datastore sequence.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Serialized.html" title="annotation in javax.jdo.annotations">Serialized</a></td>
<td class="colLast">
<div class="block">Annotation on a member (field or property) to indicate that
the member is stored serialized.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Transactional.html" title="annotation in javax.jdo.annotations">Transactional</a></td>
<td class="colLast">
<div class="block">Annotation to indicate that a member (field or property)
is transactional but not persistent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Unique.html" title="annotation in javax.jdo.annotations">Unique</a></td>
<td class="colLast">
<div class="block">Annotation for a database unique constraint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Uniques.html" title="annotation in javax.jdo.annotations">Uniques</a></td>
<td class="colLast">
<div class="block">Annotation for a group of unique constraints.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Value.html" title="annotation in javax.jdo.annotations">Value</a></td>
<td class="colLast">
<div class="block">Annotation for the value of a map relation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/jdo/annotations/Version.html" title="annotation in javax.jdo.annotations">Version</a></td>
<td class="colLast">
<div class="block">Annotation for the versioning of the class.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../javax/jdo/datastore/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/annotations/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>