jakartaee-9.0/javadoc/jakarta/persistence/MappedSuperclass.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>MappedSuperclass</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="MappedSuperclass";
         }
     }
     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/MapKeyTemporal.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/persistence/MapsId.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/MappedSuperclass.html" target="_top">Frames</a></li>
 <li><a href="MappedSuperclass.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>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Element</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 MappedSuperclass" class="title">Annotation Type MappedSuperclass</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Documented
  @Target(value=TYPE)
  @Retention(value=RUNTIME)
 public @interface <span class="memberNameLabel">MappedSuperclass</span></pre>
 <div class="block">Designates a class whose mapping information is applied
  to the entities that inherit from it. A mapped superclass
  has no separate table defined for it.

  <p> A class designated with the <code>MappedSuperclass</code>
  annotation can be mapped in the same way as an entity except that the
  mappings will apply only to its subclasses since no table
  exists for the mapped superclass itself. When applied to the
  subclasses the inherited mappings will apply in the context
  of the subclass tables. Mapping information may be overridden
  in such subclasses by using the <code>AttributeOverride</code> and
  <code>AssociationOverride</code> annotations or corresponding XML elements.

  <pre>
     Example: Concrete class as a mapped superclass

     &#064;MappedSuperclass
     public class Employee {

         &#064;Id protected Integer empId;
         &#064;Version protected Integer version;
         &#064;ManyToOne &#064;JoinColumn(name="ADDR")
         protected Address address;

         public Integer getEmpId() { ... }
         public void setEmpId(Integer id) { ... }
         public Address getAddress() { ... }
         public void setAddress(Address addr) { ... }
     }

     // Default table is FTEMPLOYEE table
     &#064;Entity
     public class FTEmployee extends Employee {

         // Inherited empId field mapped to FTEMPLOYEE.EMPID
         // Inherited version field mapped to FTEMPLOYEE.VERSION
         // Inherited address field mapped to FTEMPLOYEE.ADDR fk

         // Defaults to FTEMPLOYEE.SALARY
         protected Integer salary;

         public FTEmployee() {}

         public Integer getSalary() { ... }

         public void setSalary(Integer salary) { ... }
     }

     &#064;Entity &#064;Table(name="PT_EMP")
     &#064;AssociationOverride(
         name="address",
         joincolumns=&#064;JoinColumn(name="ADDR_ID"))
     public class PartTimeEmployee extends Employee {

         // Inherited empId field mapped to PT_EMP.EMPID
         // Inherited version field mapped to PT_EMP.VERSION
         // address field mapping overridden to PT_EMP.ADDR_ID fk
         &#064;Column(name="WAGE")
         protected Float hourlyWage;

         public PartTimeEmployee() {}

         public Float getHourlyWage() { ... }
         public void setHourlyWage(Float wage) { ... }
     }
  </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/AttributeOverride.html" title="annotation in jakarta.persistence"><code>AttributeOverride</code></a>,
 <a href="../../jakarta/persistence/AssociationOverride.html" title="annotation in jakarta.persistence"><code>AssociationOverride</code></a></dd>
 </dl>
 </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/MapKeyTemporal.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/persistence/MapsId.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/MappedSuperclass.html" target="_top">Frames</a></li>
 <li><a href="MappedSuperclass.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>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Element</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>MappedSuperclass</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="MappedSuperclass";
	}
	}
	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/MapKeyTemporal.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/persistence/MapsId.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/MappedSuperclass.html" target="_top">Frames</a></li>
	<li><a href="MappedSuperclass.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>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Element</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 MappedSuperclass" class="title">Annotation Type MappedSuperclass</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Documented
	@Target(value=TYPE)
	@Retention(value=RUNTIME)
	public @interface <span class="memberNameLabel">MappedSuperclass</span></pre>
	<div class="block">Designates a class whose mapping information is applied
	to the entities that inherit from it. A mapped superclass
	has no separate table defined for it.

	<p> A class designated with the <code>MappedSuperclass</code>
	annotation can be mapped in the same way as an entity except that the
	mappings will apply only to its subclasses since no table
	exists for the mapped superclass itself. When applied to the
	subclasses the inherited mappings will apply in the context
	of the subclass tables. Mapping information may be overridden
	in such subclasses by using the <code>AttributeOverride</code> and
	<code>AssociationOverride</code> annotations or corresponding XML elements.

	<pre>
	Example: Concrete class as a mapped superclass

	@MappedSuperclass
	public class Employee {

	@Id protected Integer empId;
	@Version protected Integer version;
	@ManyToOne @JoinColumn(name="ADDR")
	protected Address address;

	public Integer getEmpId() { ... }
	public void setEmpId(Integer id) { ... }
	public Address getAddress() { ... }
	public void setAddress(Address addr) { ... }
	}

	// Default table is FTEMPLOYEE table
	@Entity
	public class FTEmployee extends Employee {

	// Inherited empId field mapped to FTEMPLOYEE.EMPID
	// Inherited version field mapped to FTEMPLOYEE.VERSION
	// Inherited address field mapped to FTEMPLOYEE.ADDR fk

	// Defaults to FTEMPLOYEE.SALARY
	protected Integer salary;

	public FTEmployee() {}

	public Integer getSalary() { ... }

	public void setSalary(Integer salary) { ... }
	}

	@Entity @Table(name="PT_EMP")
	@AssociationOverride(
	name="address",
	joincolumns=@JoinColumn(name="ADDR_ID"))
	public class PartTimeEmployee extends Employee {

	// Inherited empId field mapped to PT_EMP.EMPID
	// Inherited version field mapped to PT_EMP.VERSION
	// address field mapping overridden to PT_EMP.ADDR_ID fk
	@Column(name="WAGE")
	protected Float hourlyWage;

	public PartTimeEmployee() {}

	public Float getHourlyWage() { ... }
	public void setHourlyWage(Float wage) { ... }
	}
	</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/AttributeOverride.html" title="annotation in jakarta.persistence"><code>AttributeOverride</code></a>,
	<a href="../../jakarta/persistence/AssociationOverride.html" title="annotation in jakarta.persistence"><code>AssociationOverride</code></a></dd>
	</dl>
	</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/MapKeyTemporal.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/persistence/MapsId.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/MappedSuperclass.html" target="_top">Frames</a></li>
	<li><a href="MappedSuperclass.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>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Element</li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>