jakartaee-9.0/javadoc/jakarta/persistence/JoinColumn.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>JoinColumn</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="JoinColumn";
         }
     }
     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/InheritanceType.html" title="enum in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/persistence/JoinColumns.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/JoinColumn.html" target="_top">Frames</a></li>
 <li><a href="JoinColumn.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">jakarta.persistence</div>
 <h2 title="Annotation Type JoinColumn" class="title">Annotation Type JoinColumn</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Repeatable(value=<a href="../../jakarta/persistence/JoinColumns.html" title="annotation in jakarta.persistence">JoinColumns.class</a>)
  @Target(value={METHOD,FIELD})
  @Retention(value=RUNTIME)
 public @interface <span class="memberNameLabel">JoinColumn</span></pre>
 <div class="block">Specifies a column for joining an entity association or element
  collection.  If the <code>JoinColumn</code> annotation itself is
  defaulted, a single join column is assumed and the default values
  apply.

  <pre>
    Example:

    &#064;ManyToOne
    &#064;JoinColumn(name="ADDR_ID")
    public Address getAddress() { return address; }


    Example: unidirectional one-to-many association using a foreign key mapping

    // In Customer class
    &#064;OneToMany
    &#064;JoinColumn(name="CUST_ID") // join column is in table for Order
    public Set&#060;Order&#062; getOrders() {return orders;}
  </pre></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>1.0</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../jakarta/persistence/ManyToOne.html" title="annotation in jakarta.persistence"><code>ManyToOne</code></a>,
 <a href="../../jakarta/persistence/OneToMany.html" title="annotation in jakarta.persistence"><code>OneToMany</code></a>,
 <a href="../../jakarta/persistence/OneToOne.html" title="annotation in jakarta.persistence"><code>OneToOne</code></a>,
 <a href="../../jakarta/persistence/JoinTable.html" title="annotation in jakarta.persistence"><code>JoinTable</code></a>,
 <a href="../../jakarta/persistence/CollectionTable.html" title="annotation in jakarta.persistence"><code>CollectionTable</code></a>,
 <a href="../../jakarta/persistence/ForeignKey.html" title="annotation in jakarta.persistence"><code>ForeignKey</code></a></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>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#columnDefinition--">columnDefinition</a></span></code>
 <div class="block">(Optional) The SQL fragment that is used when
  generating the DDL for the column.</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/JoinColumn.html#foreignKey--">foreignKey</a></span></code>
 <div class="block">(Optional) Used to specify or control the generation of a
   foreign key constraint when table generation is in effect.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#insertable--">insertable</a></span></code>
 <div class="block">(Optional) Whether the column is included in
  SQL INSERT statements generated by the persistence
  provider.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#name--">name</a></span></code>
 <div class="block">(Optional) The name of the foreign key column.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#nullable--">nullable</a></span></code>
 <div class="block">(Optional) Whether the foreign key column is nullable.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#referencedColumnName--">referencedColumnName</a></span></code>
 <div class="block">(Optional) The name of the column referenced by this foreign
  key column.</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/JoinColumn.html#table--">table</a></span></code>
 <div class="block">(Optional) The name of the table that contains
  the column.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#unique--">unique</a></span></code>
 <div class="block">(Optional) Whether the property is a unique key.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#updatable--">updatable</a></span></code>
 <div class="block">(Optional) Whether the column is included in
  SQL UPDATE statements generated by the persistence
  provider.</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="blockList">
 <li class="blockList">
 <h4>name</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
 <div class="block">(Optional) The name of the foreign key column.
  The table in which it is found depends upon the
  context.
  <ul>
  <li>If the join is for a OneToOne or ManyToOne
   mapping using a foreign key mapping strategy,
  the foreign key column is in the table of the
  source entity or embeddable.
  <li> If the join is for a unidirectional OneToMany mapping
  using a foreign key mapping strategy, the foreign key is in the
  table of the target entity.
  <li> If the join is for a ManyToMany mapping or for a OneToOne
  or bidirectional ManyToOne/OneToMany mapping using a join
  table, the foreign key is in a join table.
  <li> If the join is for an element collection, the foreign
  key is in a collection table.
 </ul>

  <p> Default (only applies if a single join column is used):
  The concatenation of the following: the name of the
  referencing relationship property or field of the referencing
  entity or embeddable class; "_"; the name of the referenced
  primary key column.
  If there is no such referencing relationship property or
  field in the entity, or if the join is for an element collection,
  the join column name is formed as the
  concatenation of the following: the name of the entity; "_";
  the name of the referenced primary key column.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="referencedColumnName--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>referencedColumnName</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;referencedColumnName</pre>
 <div class="block">(Optional) The name of the column referenced by this foreign
  key column.
  <ul>
  <li> When used with entity relationship mappings other
  than the cases described here, the referenced column is in the
  table of the target entity.
  <li> When used with a unidirectional OneToMany foreign key
  mapping, the referenced column is in the table of the source
  entity.
  <li> When used inside a <code>JoinTable</code> annotation,
  the referenced key column is in the entity table of the owning
  entity, or inverse entity if the join is part of the inverse
  join definition.
  <li> When used in a <code>CollectionTable</code> mapping, the
  referenced column is in the table of the entity containing the
  collection.
  </ul>

  <p> Default (only applies if single join column is being
  used): The same name as the primary key column of the
  referenced table.</div>
 <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;boolean&nbsp;unique</pre>
 <div class="block">(Optional) Whether the property is a unique key.  This is a
  shortcut for the <code>UniqueConstraint</code> annotation at
  the table level and is useful for when the unique key
  constraint is only a single field. It is not necessary to
  explicitly specify this for a join column that corresponds to a
  primary key that is part of a foreign key.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="nullable--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>nullable</h4>
 <pre>public abstract&nbsp;boolean&nbsp;nullable</pre>
 <div class="block">(Optional) Whether the foreign key column is nullable.</div>
 <dl>
 <dt>Default:</dt>
 <dd>true</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="insertable--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>insertable</h4>
 <pre>public abstract&nbsp;boolean&nbsp;insertable</pre>
 <div class="block">(Optional) Whether the column is included in
  SQL INSERT statements generated by the persistence
  provider.</div>
 <dl>
 <dt>Default:</dt>
 <dd>true</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="updatable--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>updatable</h4>
 <pre>public abstract&nbsp;boolean&nbsp;updatable</pre>
 <div class="block">(Optional) Whether the column is included in
  SQL UPDATE statements generated by the persistence
  provider.</div>
 <dl>
 <dt>Default:</dt>
 <dd>true</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="columnDefinition--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>columnDefinition</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;columnDefinition</pre>
 <div class="block">(Optional) The SQL fragment that is used when
  generating the DDL for the column.
  <p> Defaults to the generated SQL for the column.</div>
 <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;java.lang.String&nbsp;table</pre>
 <div class="block">(Optional) The name of the table that contains
  the column. If a table is not specified, the column
  is assumed to be in the primary table of the
  applicable entity.

  <p> Default:
  <ul>
  <li> If the join is for a OneToOne or ManyToOne mapping
  using a foreign key mapping strategy, the name of the table of
  the source entity or embeddable.
  <li> If the join is for a unidirectional OneToMany mapping
  using a foreign key mapping strategy, the name of the table of
  the target entity.
  <li> If the join is for a ManyToMany mapping or
  for a OneToOne or bidirectional ManyToOne/OneToMany mapping
  using a join table, the name of the join table.
  <li> If the join is for an element collection, the name of the collection table.
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="foreignKey--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <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 when table generation is in effect.  If
   this element is not specified, 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>
 </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/InheritanceType.html" title="enum in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/persistence/JoinColumns.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/JoinColumn.html" target="_top">Frames</a></li>
 <li><a href="JoinColumn.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 ======= -->
 </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>JoinColumn</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="JoinColumn";
	}
	}
	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/InheritanceType.html" title="enum in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/persistence/JoinColumns.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/JoinColumn.html" target="_top">Frames</a></li>
	<li><a href="JoinColumn.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>Required \| </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 JoinColumn" class="title">Annotation Type JoinColumn</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Repeatable(value=<a href="../../jakarta/persistence/JoinColumns.html" title="annotation in jakarta.persistence">JoinColumns.class</a>)
	@Target(value={METHOD,FIELD})
	@Retention(value=RUNTIME)
	public @interface <span class="memberNameLabel">JoinColumn</span></pre>
	<div class="block">Specifies a column for joining an entity association or element
	collection. If the <code>JoinColumn</code> annotation itself is
	defaulted, a single join column is assumed and the default values
	apply.

	<pre>
	Example:

	@ManyToOne
	@JoinColumn(name="ADDR_ID")
	public Address getAddress() { return address; }


	Example: unidirectional one-to-many association using a foreign key mapping

	// In Customer class
	@OneToMany
	@JoinColumn(name="CUST_ID") // join column is in table for Order
	public Set<Order> getOrders() {return orders;}
	</pre></div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>1.0</dd>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="../../jakarta/persistence/ManyToOne.html" title="annotation in jakarta.persistence"><code>ManyToOne</code></a>,
	<a href="../../jakarta/persistence/OneToMany.html" title="annotation in jakarta.persistence"><code>OneToMany</code></a>,
	<a href="../../jakarta/persistence/OneToOne.html" title="annotation in jakarta.persistence"><code>OneToOne</code></a>,
	<a href="../../jakarta/persistence/JoinTable.html" title="annotation in jakarta.persistence"><code>JoinTable</code></a>,
	<a href="../../jakarta/persistence/CollectionTable.html" title="annotation in jakarta.persistence"><code>CollectionTable</code></a>,
	<a href="../../jakarta/persistence/ForeignKey.html" title="annotation in jakarta.persistence"><code>ForeignKey</code></a></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"> </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/JoinColumn.html#columnDefinition--">columnDefinition</a></span></code>
	<div class="block">(Optional) The SQL fragment that is used when
	generating the DDL for the column.</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/JoinColumn.html#foreignKey--">foreignKey</a></span></code>
	<div class="block">(Optional) Used to specify or control the generation of a
	foreign key constraint when table generation is in effect.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#insertable--">insertable</a></span></code>
	<div class="block">(Optional) Whether the column is included in
	SQL INSERT statements generated by the persistence
	provider.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#name--">name</a></span></code>
	<div class="block">(Optional) The name of the foreign key column.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#nullable--">nullable</a></span></code>
	<div class="block">(Optional) Whether the foreign key column is nullable.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#referencedColumnName--">referencedColumnName</a></span></code>
	<div class="block">(Optional) The name of the column referenced by this foreign
	key column.</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/JoinColumn.html#table--">table</a></span></code>
	<div class="block">(Optional) The name of the table that contains
	the column.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#unique--">unique</a></span></code>
	<div class="block">(Optional) Whether the property is a unique key.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/JoinColumn.html#updatable--">updatable</a></span></code>
	<div class="block">(Optional) Whether the column is included in
	SQL UPDATE statements generated by the persistence
	provider.</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="blockList">
	<li class="blockList">
	<h4>name</h4>
	<pre>public abstract java.lang.String name</pre>
	<div class="block">(Optional) The name of the foreign key column.
	The table in which it is found depends upon the
	context.
	<ul>
	<li>If the join is for a OneToOne or ManyToOne
	mapping using a foreign key mapping strategy,
	the foreign key column is in the table of the
	source entity or embeddable.
	<li> If the join is for a unidirectional OneToMany mapping
	using a foreign key mapping strategy, the foreign key is in the
	table of the target entity.
	<li> If the join is for a ManyToMany mapping or for a OneToOne
	or bidirectional ManyToOne/OneToMany mapping using a join
	table, the foreign key is in a join table.
	<li> If the join is for an element collection, the foreign
	key is in a collection table.
	</ul>

	<p> Default (only applies if a single join column is used):
	The concatenation of the following: the name of the
	referencing relationship property or field of the referencing
	entity or embeddable class; "_"; the name of the referenced
	primary key column.
	If there is no such referencing relationship property or
	field in the entity, or if the join is for an element collection,
	the join column name is formed as the
	concatenation of the following: the name of the entity; "_";
	the name of the referenced primary key column.</div>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="referencedColumnName--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>referencedColumnName</h4>
	<pre>public abstract java.lang.String referencedColumnName</pre>
	<div class="block">(Optional) The name of the column referenced by this foreign
	key column.
	<ul>
	<li> When used with entity relationship mappings other
	than the cases described here, the referenced column is in the
	table of the target entity.
	<li> When used with a unidirectional OneToMany foreign key
	mapping, the referenced column is in the table of the source
	entity.
	<li> When used inside a <code>JoinTable</code> annotation,
	the referenced key column is in the entity table of the owning
	entity, or inverse entity if the join is part of the inverse
	join definition.
	<li> When used in a <code>CollectionTable</code> mapping, the
	referenced column is in the table of the entity containing the
	collection.
	</ul>

	<p> Default (only applies if single join column is being
	used): The same name as the primary key column of the
	referenced table.</div>
	<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 boolean unique</pre>
	<div class="block">(Optional) Whether the property is a unique key. This is a
	shortcut for the <code>UniqueConstraint</code> annotation at
	the table level and is useful for when the unique key
	constraint is only a single field. It is not necessary to
	explicitly specify this for a join column that corresponds to a
	primary key that is part of a foreign key.</div>
	<dl>
	<dt>Default:</dt>
	<dd>false</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="nullable--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>nullable</h4>
	<pre>public abstract boolean nullable</pre>
	<div class="block">(Optional) Whether the foreign key column is nullable.</div>
	<dl>
	<dt>Default:</dt>
	<dd>true</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="insertable--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>insertable</h4>
	<pre>public abstract boolean insertable</pre>
	<div class="block">(Optional) Whether the column is included in
	SQL INSERT statements generated by the persistence
	provider.</div>
	<dl>
	<dt>Default:</dt>
	<dd>true</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="updatable--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>updatable</h4>
	<pre>public abstract boolean updatable</pre>
	<div class="block">(Optional) Whether the column is included in
	SQL UPDATE statements generated by the persistence
	provider.</div>
	<dl>
	<dt>Default:</dt>
	<dd>true</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="columnDefinition--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>columnDefinition</h4>
	<pre>public abstract java.lang.String columnDefinition</pre>
	<div class="block">(Optional) The SQL fragment that is used when
	generating the DDL for the column.
	<p> Defaults to the generated SQL for the column.</div>
	<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 java.lang.String table</pre>
	<div class="block">(Optional) The name of the table that contains
	the column. If a table is not specified, the column
	is assumed to be in the primary table of the
	applicable entity.

	<p> Default:
	<ul>
	<li> If the join is for a OneToOne or ManyToOne mapping
	using a foreign key mapping strategy, the name of the table of
	the source entity or embeddable.
	<li> If the join is for a unidirectional OneToMany mapping
	using a foreign key mapping strategy, the name of the table of
	the target entity.
	<li> If the join is for a ManyToMany mapping or
	for a OneToOne or bidirectional ManyToOne/OneToMany mapping
	using a join table, the name of the join table.
	<li> If the join is for an element collection, the name of the collection table.
	</ul></div>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="foreignKey--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<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 when table generation is in effect. If
	this element is not specified, 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>
	</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/InheritanceType.html" title="enum in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/persistence/JoinColumns.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/JoinColumn.html" target="_top">Frames</a></li>
	<li><a href="JoinColumn.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>Required \| </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>