jakartaee-9.0/javadoc/jakarta/persistence/SecondaryTable.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>SecondaryTable</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="SecondaryTable";
         }
     }
     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="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="../../jakarta/persistence/RollbackException.html" title="class in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/persistence/SecondaryTables.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../index.html?jakarta/persistence/SecondaryTable.html" target="_top">Frames</a></li>
 <li><a href="SecondaryTable.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><a href="#annotation.type.required.element.summary">Required</a>&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">jakarta.persistence</div>
 <h2 title="Annotation Type SecondaryTable" class="title">Annotation Type SecondaryTable</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Repeatable(value=<a href="../../jakarta/persistence/SecondaryTables.html" title="annotation in jakarta.persistence">SecondaryTables.class</a>)
  @Target(value=TYPE)
  @Retention(value=RUNTIME)
 public @interface <span class="memberNameLabel">SecondaryTable</span></pre>
 <div class="block">Specifies a secondary table for the annotated entity
  class. Specifying one or more secondary tables indicates that the
  data for the entity class is stored across multiple tables.

  <p> If no <code>SecondaryTable</code> annotation is specified,
  it is assumed that all persistent fields or properties of the
  entity are mapped to the primary table. If no primary key join
  columns are specified, the join columns are assumed to reference
  the primary key columns of the primary table, and have the same
  names and types as the referenced primary key columns of the
  primary table.

  <pre>
     Example 1: Single secondary table with a single primary key column.

     &#064;Entity
     &#064;Table(name="CUSTOMER")
     &#064;SecondaryTable(name="CUST_DETAIL",
         pkJoinColumns=&#064;PrimaryKeyJoinColumn(name="CUST_ID"))
     public class Customer { ... }


     Example 2: Single secondary table with multiple primary key columns.

     &#064;Entity
     &#064;Table(name="CUSTOMER")
     &#064;SecondaryTable(name="CUST_DETAIL",
         pkJoinColumns={
             &#064;PrimaryKeyJoinColumn(name="CUST_ID"),
             &#064;PrimaryKeyJoinColumn(name="CUST_TYPE")})
     public class Customer { ... }
  </pre></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>1.0</dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.required.element.summary">
 <!--   -->
 </a>
 <h3>Required Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
 <caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Required Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#name--">name</a></span></code>
 <div class="block">(Required) The name of the table.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- =========== 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>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#catalog--">catalog</a></span></code>
 <div class="block">(Optional) The catalog of the table.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../jakarta/persistence/ForeignKey.html" title="annotation in jakarta.persistence">ForeignKey</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#foreignKey--">foreignKey</a></span></code>
 <div class="block">(Optional) Used to specify or control the generation of a
    foreign key constraint for the columns corresponding to the
    <code>pkJoinColumns</code> element when table generation is
    in effect.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../jakarta/persistence/Index.html" title="annotation in jakarta.persistence">Index</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#indexes--">indexes</a></span></code>
 <div class="block">(Optional) Indexes for the table.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../jakarta/persistence/PrimaryKeyJoinColumn.html" title="annotation in jakarta.persistence">PrimaryKeyJoinColumn</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#pkJoinColumns--">pkJoinColumns</a></span></code>
 <div class="block">(Optional) The columns that are used to join with
  the primary table.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#schema--">schema</a></span></code>
 <div class="block">(Optional) The schema of the table.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../jakarta/persistence/UniqueConstraint.html" title="annotation in jakarta.persistence">UniqueConstraint</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#uniqueConstraints--">uniqueConstraints</a></span></code>
 <div class="block">(Optional) Unique constraints that are to be placed on the
  table.</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="name--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>name</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
 <div class="block">(Required) The name of the table.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="catalog--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>catalog</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;catalog</pre>
 <div class="block">(Optional) The catalog of the table.
  <p> Defaults to the default catalog.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="schema--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>schema</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;schema</pre>
 <div class="block">(Optional) The schema of the table.
  <p> Defaults to the default schema for user.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="pkJoinColumns--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>pkJoinColumns</h4>
 <pre>public abstract&nbsp;<a href="../../jakarta/persistence/PrimaryKeyJoinColumn.html" title="annotation in jakarta.persistence">PrimaryKeyJoinColumn</a>[]&nbsp;pkJoinColumns</pre>
 <div class="block">(Optional) The columns that are used to join with
  the primary table.
  <p> Defaults to the column(s) of the same name(s)
  as the primary key column(s) in the primary table.</div>
 <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="../../jakarta/persistence/ForeignKey.html" title="annotation in jakarta.persistence">ForeignKey</a>&nbsp;foreignKey</pre>
 <div class="block">(Optional) Used to specify or control the generation of a
    foreign key constraint for the columns corresponding to the
    <code>pkJoinColumns</code> element when table generation is
    in effect.  If both this element and the
    <code>foreignKey</code> element of any of the
    <code>pkJoinColumns</code> elements are specified, the
    behavior is undefined.  If no foreign key annotation element
    is specified in either location, the persistence provider's
    default foreign key strategy will apply.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>2.1</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>@jakarta.persistence.ForeignKey(jakarta.persistence.ConstraintMode.PROVIDER_DEFAULT)</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="uniqueConstraints--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>uniqueConstraints</h4>
 <pre>public abstract&nbsp;<a href="../../jakarta/persistence/UniqueConstraint.html" title="annotation in jakarta.persistence">UniqueConstraint</a>[]&nbsp;uniqueConstraints</pre>
 <div class="block">(Optional) Unique constraints that are to be placed on the
  table. These are typically only used if table generation
  is in effect. These constraints apply in addition to any
  constraints specified by the <code>Column</code> and <code>JoinColumn</code>
  annotations and constraints entailed by primary key mappings.
  <p> Defaults to no additional constraints.</div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="indexes--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>indexes</h4>
 <pre>public abstract&nbsp;<a href="../../jakarta/persistence/Index.html" title="annotation in jakarta.persistence">Index</a>[]&nbsp;indexes</pre>
 <div class="block">(Optional) Indexes for the table.  These are only used if
  table generation is in effect.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>2.1</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="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="../../jakarta/persistence/RollbackException.html" title="class in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/persistence/SecondaryTables.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../index.html?jakarta/persistence/SecondaryTable.html" target="_top">Frames</a></li>
 <li><a href="SecondaryTable.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><a href="#annotation.type.required.element.summary">Required</a>&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 ======= -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<title>SecondaryTable</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="SecondaryTable";
	}
	}
	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="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="../../jakarta/persistence/RollbackException.html" title="class in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/persistence/SecondaryTables.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../index.html?jakarta/persistence/SecondaryTable.html" target="_top">Frames</a></li>
	<li><a href="SecondaryTable.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: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </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">jakarta.persistence</div>
	<h2 title="Annotation Type SecondaryTable" class="title">Annotation Type SecondaryTable</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Repeatable(value=<a href="../../jakarta/persistence/SecondaryTables.html" title="annotation in jakarta.persistence">SecondaryTables.class</a>)
	@Target(value=TYPE)
	@Retention(value=RUNTIME)
	public @interface <span class="memberNameLabel">SecondaryTable</span></pre>
	<div class="block">Specifies a secondary table for the annotated entity
	class. Specifying one or more secondary tables indicates that the
	data for the entity class is stored across multiple tables.

	<p> If no <code>SecondaryTable</code> annotation is specified,
	it is assumed that all persistent fields or properties of the
	entity are mapped to the primary table. If no primary key join
	columns are specified, the join columns are assumed to reference
	the primary key columns of the primary table, and have the same
	names and types as the referenced primary key columns of the
	primary table.

	<pre>
	Example 1: Single secondary table with a single primary key column.

	@Entity
	@Table(name="CUSTOMER")
	@SecondaryTable(name="CUST_DETAIL",
	pkJoinColumns=@PrimaryKeyJoinColumn(name="CUST_ID"))
	public class Customer { ... }


	Example 2: Single secondary table with multiple primary key columns.

	@Entity
	@Table(name="CUSTOMER")
	@SecondaryTable(name="CUST_DETAIL",
	pkJoinColumns={
	@PrimaryKeyJoinColumn(name="CUST_ID"),
	@PrimaryKeyJoinColumn(name="CUST_TYPE")})
	public class Customer { ... }
	</pre></div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>1.0</dd>
	</dl>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.required.element.summary">
	<!-- -->
	</a>
	<h3>Required Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
	<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Required Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#name--">name</a></span></code>
	<div class="block">(Required) The name of the table.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- =========== 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"> </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>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#catalog--">catalog</a></span></code>
	<div class="block">(Optional) The catalog of the table.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code><a href="../../jakarta/persistence/ForeignKey.html" title="annotation in jakarta.persistence">ForeignKey</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#foreignKey--">foreignKey</a></span></code>
	<div class="block">(Optional) Used to specify or control the generation of a
	foreign key constraint for the columns corresponding to the
	<code>pkJoinColumns</code> element when table generation is
	in effect.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code><a href="../../jakarta/persistence/Index.html" title="annotation in jakarta.persistence">Index</a>[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#indexes--">indexes</a></span></code>
	<div class="block">(Optional) Indexes for the table.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code><a href="../../jakarta/persistence/PrimaryKeyJoinColumn.html" title="annotation in jakarta.persistence">PrimaryKeyJoinColumn</a>[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#pkJoinColumns--">pkJoinColumns</a></span></code>
	<div class="block">(Optional) The columns that are used to join with
	the primary table.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#schema--">schema</a></span></code>
	<div class="block">(Optional) The schema of the table.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code><a href="../../jakarta/persistence/UniqueConstraint.html" title="annotation in jakarta.persistence">UniqueConstraint</a>[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/SecondaryTable.html#uniqueConstraints--">uniqueConstraints</a></span></code>
	<div class="block">(Optional) Unique constraints that are to be placed on the
	table.</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="name--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>name</h4>
	<pre>public abstract java.lang.String name</pre>
	<div class="block">(Required) The name of the table.</div>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="catalog--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>catalog</h4>
	<pre>public abstract java.lang.String catalog</pre>
	<div class="block">(Optional) The catalog of the table.
	<p> Defaults to the default catalog.</div>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="schema--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>schema</h4>
	<pre>public abstract java.lang.String schema</pre>
	<div class="block">(Optional) The schema of the table.
	<p> Defaults to the default schema for user.</div>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="pkJoinColumns--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>pkJoinColumns</h4>
	<pre>public abstract <a href="../../jakarta/persistence/PrimaryKeyJoinColumn.html" title="annotation in jakarta.persistence">PrimaryKeyJoinColumn</a>[] pkJoinColumns</pre>
	<div class="block">(Optional) The columns that are used to join with
	the primary table.
	<p> Defaults to the column(s) of the same name(s)
	as the primary key column(s) in the primary table.</div>
	<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 <a href="../../jakarta/persistence/ForeignKey.html" title="annotation in jakarta.persistence">ForeignKey</a> foreignKey</pre>
	<div class="block">(Optional) Used to specify or control the generation of a
	foreign key constraint for the columns corresponding to the
	<code>pkJoinColumns</code> element when table generation is
	in effect. If both this element and the
	<code>foreignKey</code> element of any of the
	<code>pkJoinColumns</code> elements are specified, the
	behavior is undefined. If no foreign key annotation element
	is specified in either location, the persistence provider's
	default foreign key strategy will apply.</div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>2.1</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>@jakarta.persistence.ForeignKey(jakarta.persistence.ConstraintMode.PROVIDER_DEFAULT)</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="uniqueConstraints--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>uniqueConstraints</h4>
	<pre>public abstract <a href="../../jakarta/persistence/UniqueConstraint.html" title="annotation in jakarta.persistence">UniqueConstraint</a>[] uniqueConstraints</pre>
	<div class="block">(Optional) Unique constraints that are to be placed on the
	table. These are typically only used if table generation
	is in effect. These constraints apply in addition to any
	constraints specified by the <code>Column</code> and <code>JoinColumn</code>
	annotations and constraints entailed by primary key mappings.
	<p> Defaults to no additional constraints.</div>
	<dl>
	<dt>Default:</dt>
	<dd>{}</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="indexes--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>indexes</h4>
	<pre>public abstract <a href="../../jakarta/persistence/Index.html" title="annotation in jakarta.persistence">Index</a>[] indexes</pre>
	<div class="block">(Optional) Indexes for the table. These are only used if
	table generation is in effect.</div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>2.1</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="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="../../jakarta/persistence/RollbackException.html" title="class in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/persistence/SecondaryTables.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../index.html?jakarta/persistence/SecondaryTable.html" target="_top">Frames</a></li>
	<li><a href="SecondaryTable.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: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>