api/1.2/javax/persistence/SecondaryTable.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--NewPage-->
 <HTML>
 <HEAD>
 <!-- Generated by javadoc (build 1.6.0) on Fri Oct 16 14:57:47 EDT 2009 -->
 <TITLE>
 SecondaryTable (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)
 </TITLE>

 <META NAME="date" CONTENT="2009-10-16">

 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">

 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
         parent.document.title="SecondaryTable (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)";
     }
 }
 </SCRIPT>
 <NOSCRIPT>
 </NOSCRIPT>

 </HEAD>

 <BODY BGCOLOR="white" onload="windowTitle();">
 <HR>


 <!-- ========= START OF TOP NAVBAR ======= -->
 <A NAME="navbar_top"><!-- --></A>
 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_top_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../javax/persistence/RollbackException.html" title="class in javax.persistence"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../javax/persistence/SecondaryTables.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../index.html?javax/persistence/SecondaryTable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="SecondaryTable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;<A HREF="#annotation_type_required_element_summary">REQUIRED</A>&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_top"></A>
 <!-- ========= END OF TOP NAVBAR ========= -->

 <HR>
 <!-- ======== START OF CLASS DATA ======== -->
 <H2>
 <FONT SIZE="-1">
 javax.persistence</FONT>
 <BR>
 Annotation Type SecondaryTable</H2>
 <HR>
 <DL>
 <DT><PRE><FONT SIZE="-1">@Target(value=TYPE)
 @Retention(value=RUNTIME)
 </FONT>public @interface <B>SecondaryTable</B></DL>
 </PRE>

 <P>
 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>
 <P>

 <P>
 <DL>
 <DT><B>Since:</B></DT>
   <DD>Java Persistence 1.0</DD>
 </DL>
 <HR>

 <P>
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->

 <A NAME="annotation_type_required_element_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Required Element Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#name()">name</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Required) The name of the table.</TD>
 </TR>
 </TABLE>
 &nbsp;<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->

 <A NAME="annotation_type_optional_element_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Optional Element Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#catalog()">catalog</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Optional) The catalog of the table.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;<A HREF="../../javax/persistence/PrimaryKeyJoinColumn.html" title="annotation in javax.persistence">PrimaryKeyJoinColumn</A>[]</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#pkJoinColumns()">pkJoinColumns</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Optional) The columns that are used to join with
  the primary table.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#schema()">schema</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Optional) The schema of the table.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;<A HREF="../../javax/persistence/UniqueConstraint.html" title="annotation in javax.persistence">UniqueConstraint</A>[]</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#uniqueConstraints()">uniqueConstraints</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Optional) Unique constraints that are to be placed on the
  table.</TD>
 </TR>
 </TABLE>
 &nbsp;
 <P>

 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->

 <A NAME="annotation_type_element_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Element Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="name()"><!-- --></A><H3>
 name</H3>
 <PRE>
 public abstract java.lang.String <B>name</B></PRE>
 <DL>
 <DD>(Required) The name of the table.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 </DL>
 <A NAME="catalog()"><!-- --></A><H3>
 catalog</H3>
 <PRE>
 public abstract java.lang.String <B>catalog</B></PRE>
 <DL>
 <DD>(Optional) The catalog of the table.
  <p> Defaults to the default catalog.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>""</DD>
 </DL>
 </DL>
 <HR>

 <A NAME="schema()"><!-- --></A><H3>
 schema</H3>
 <PRE>
 public abstract java.lang.String <B>schema</B></PRE>
 <DL>
 <DD>(Optional) The schema of the table.
  <p> Defaults to the default schema for user.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>""</DD>
 </DL>
 </DL>
 <HR>

 <A NAME="pkJoinColumns()"><!-- --></A><H3>
 pkJoinColumns</H3>
 <PRE>
 public abstract <A HREF="../../javax/persistence/PrimaryKeyJoinColumn.html" title="annotation in javax.persistence">PrimaryKeyJoinColumn</A>[] <B>pkJoinColumns</B></PRE>
 <DL>
 <DD>(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.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>{}</DD>
 </DL>
 </DL>
 <HR>

 <A NAME="uniqueConstraints()"><!-- --></A><H3>
 uniqueConstraints</H3>
 <PRE>
 public abstract <A HREF="../../javax/persistence/UniqueConstraint.html" title="annotation in javax.persistence">UniqueConstraint</A>[] <B>uniqueConstraints</B></PRE>
 <DL>
 <DD>(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.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>{}</DD>
 </DL>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>


 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <A NAME="navbar_bottom"><!-- --></A>
 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../javax/persistence/RollbackException.html" title="class in javax.persistence"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../javax/persistence/SecondaryTables.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../index.html?javax/persistence/SecondaryTable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="SecondaryTable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;<A HREF="#annotation_type_required_element_summary">REQUIRED</A>&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_bottom"></A>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->

 <HR>

 </BODY>
 </HTML>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--NewPage-->
	<HTML>
	<HEAD>
	<!-- Generated by javadoc (build 1.6.0) on Fri Oct 16 14:57:47 EDT 2009 -->
	<TITLE>
	SecondaryTable (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)
	</TITLE>

	<META NAME="date" CONTENT="2009-10-16">

	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">

	<SCRIPT type="text/javascript">
	function windowTitle()
	{
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="SecondaryTable (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)";
	}
	}
	</SCRIPT>
	<NOSCRIPT>
	</NOSCRIPT>

	</HEAD>

	<BODY BGCOLOR="white" onload="windowTitle();">
	<HR>


	<!-- ========= START OF TOP NAVBAR ======= -->
	<A NAME="navbar_top"><!-- --></A>
	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_top_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../javax/persistence/RollbackException.html" title="class in javax.persistence"><B>PREV CLASS</B></A>
	<A HREF="../../javax/persistence/SecondaryTables.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../index.html?javax/persistence/SecondaryTable.html" target="_top"><B>FRAMES</B></A>
	<A HREF="SecondaryTable.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> \| <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_top"></A>
	<!-- ========= END OF TOP NAVBAR ========= -->

	<HR>
	<!-- ======== START OF CLASS DATA ======== -->
	<H2>
	<FONT SIZE="-1">
	javax.persistence</FONT>
	<BR>
	Annotation Type SecondaryTable</H2>
	<HR>
	<DL>
	<DT><PRE><FONT SIZE="-1">@Target(value=TYPE)
	@Retention(value=RUNTIME)
	</FONT>public @interface <B>SecondaryTable</B></DL>
	</PRE>

	<P>
	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>
	<P>

	<P>
	<DL>
	<DT><B>Since:</B></DT>
	<DD>Java Persistence 1.0</DD>
	</DL>
	<HR>

	<P>
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->

	<A NAME="annotation_type_required_element_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Required Element Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#name()">name</A></B></CODE>

	<BR>
	(Required) The name of the table.</TD>
	</TR>
	</TABLE>
	<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->

	<A NAME="annotation_type_optional_element_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Optional Element Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#catalog()">catalog</A></B></CODE>

	<BR>
	(Optional) The catalog of the table.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> <A HREF="../../javax/persistence/PrimaryKeyJoinColumn.html" title="annotation in javax.persistence">PrimaryKeyJoinColumn</A>[]</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#pkJoinColumns()">pkJoinColumns</A></B></CODE>

	<BR>
	(Optional) The columns that are used to join with
	the primary table.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#schema()">schema</A></B></CODE>

	<BR>
	(Optional) The schema of the table.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> <A HREF="../../javax/persistence/UniqueConstraint.html" title="annotation in javax.persistence">UniqueConstraint</A>[]</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../javax/persistence/SecondaryTable.html#uniqueConstraints()">uniqueConstraints</A></B></CODE>

	<BR>
	(Optional) Unique constraints that are to be placed on the
	table.</TD>
	</TR>
	</TABLE>

	<P>

	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->

	<A NAME="annotation_type_element_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Element Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="name()"><!-- --></A><H3>
	name</H3>
	<PRE>
	public abstract java.lang.String <B>name</B></PRE>
	<DL>
	<DD>(Required) The name of the table.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	</DL>
	<A NAME="catalog()"><!-- --></A><H3>
	catalog</H3>
	<PRE>
	public abstract java.lang.String <B>catalog</B></PRE>
	<DL>
	<DD>(Optional) The catalog of the table.
	<p> Defaults to the default catalog.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>""</DD>
	</DL>
	</DL>
	<HR>

	<A NAME="schema()"><!-- --></A><H3>
	schema</H3>
	<PRE>
	public abstract java.lang.String <B>schema</B></PRE>
	<DL>
	<DD>(Optional) The schema of the table.
	<p> Defaults to the default schema for user.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>""</DD>
	</DL>
	</DL>
	<HR>

	<A NAME="pkJoinColumns()"><!-- --></A><H3>
	pkJoinColumns</H3>
	<PRE>
	public abstract <A HREF="../../javax/persistence/PrimaryKeyJoinColumn.html" title="annotation in javax.persistence">PrimaryKeyJoinColumn</A>[] <B>pkJoinColumns</B></PRE>
	<DL>
	<DD>(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.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>{}</DD>
	</DL>
	</DL>
	<HR>

	<A NAME="uniqueConstraints()"><!-- --></A><H3>
	uniqueConstraints</H3>
	<PRE>
	public abstract <A HREF="../../javax/persistence/UniqueConstraint.html" title="annotation in javax.persistence">UniqueConstraint</A>[] <B>uniqueConstraints</B></PRE>
	<DL>
	<DD>(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.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>{}</DD>
	</DL>
	</DL>
	<!-- ========= END OF CLASS DATA ========= -->
	<HR>


	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<A NAME="navbar_bottom"><!-- --></A>
	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_bottom_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../javax/persistence/RollbackException.html" title="class in javax.persistence"><B>PREV CLASS</B></A>
	<A HREF="../../javax/persistence/SecondaryTables.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../index.html?javax/persistence/SecondaryTable.html" target="_top"><B>FRAMES</B></A>
	<A HREF="SecondaryTable.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> \| <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_bottom"></A>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->

	<HR>

	</BODY>
	</HTML>