| <!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 Sep 25 03:18:14 EDT 2009 --> |
| <TITLE> |
| TableGenerator (EclipseLink 1.1.3, build 'v20090925-r5281' API Reference) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-09-25"> |
| |
| <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="TableGenerator (EclipseLink 1.1.3, build 'v20090925-r5281' 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.1.3, build 'v20090925-r5281' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/Table.html" title="annotation in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/Temporal.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/TableGenerator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="TableGenerator.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 TableGenerator</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1">@Target(value={TYPE,METHOD,FIELD}) |
| @Retention(value=RUNTIME) |
| </FONT>public @interface <B>TableGenerator</B></DL> |
| </PRE> |
| |
| <P> |
| This annotation defines a primary key generator that may be |
| referenced by name when a generator element is specified for |
| the <A HREF="../../javax/persistence/GeneratedValue.html" title="annotation in javax.persistence"><CODE>GeneratedValue</CODE></A> annotation. A table generator |
| may be specified on the entity class or on the primary key |
| field or property. The scope of the generator name is global |
| to the persistence unit (across all generator types). |
| |
| <pre> |
| Example 1: |
| |
| @Entity public class Employee { |
| ... |
| @TableGenerator( |
| name="empGen", |
| table="ID_GEN", |
| pkColumnName="GEN_KEY", |
| valueColumnName="GEN_VALUE", |
| pkColumnValue="EMP_ID", |
| allocationSize=1) |
| @Id |
| @GeneratedValue(strategy=TABLE, generator="empGen") |
| public int id; |
| ... |
| } |
| |
| Example 2: |
| |
| @Entity public class Address { |
| ... |
| @TableGenerator( |
| name="addressGen", |
| table="ID_GEN", |
| pkColumnName="GEN_KEY", |
| valueColumnName="GEN_VALUE", |
| pkColumnValue="ADDR_ID") |
| @Id |
| @GeneratedValue(strategy=TABLE, generator="addressGen") |
| public int id; |
| ... |
| } |
| </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/TableGenerator.html#name()">name</A></B></CODE> |
| |
| <BR> |
| (Required) A unique generator name that can be referenced |
| by one or more classes to be the generator for id values.</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> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/TableGenerator.html#allocationSize()">allocationSize</A></B></CODE> |
| |
| <BR> |
| (Optional) The amount to increment by when allocating id |
| numbers from the generator.</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/TableGenerator.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> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/TableGenerator.html#initialValue()">initialValue</A></B></CODE> |
| |
| <BR> |
| (Optional) The initial value to be used when allocating id |
| numbers from the generator.</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/TableGenerator.html#pkColumnName()">pkColumnName</A></B></CODE> |
| |
| <BR> |
| (Optional) Name of the primary key column in the 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/TableGenerator.html#pkColumnValue()">pkColumnValue</A></B></CODE> |
| |
| <BR> |
| (Optional) The primary key value in the generator table |
| that distinguishes this set of generated values from others |
| that may be stored in the 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/TableGenerator.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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/TableGenerator.html#table()">table</A></B></CODE> |
| |
| <BR> |
| (Optional) Name of table that stores the generated id values.</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/TableGenerator.html#uniqueConstraints()">uniqueConstraints</A></B></CODE> |
| |
| <BR> |
| (Optional) Unique constraints that are to be placed on the |
| 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/TableGenerator.html#valueColumnName()">valueColumnName</A></B></CODE> |
| |
| <BR> |
| (Optional) Name of the column that stores the last value generated.</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) A unique generator name that can be referenced |
| by one or more classes to be the generator for id values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DL> |
| <A NAME="table()"><!-- --></A><H3> |
| table</H3> |
| <PRE> |
| public abstract java.lang.String <B>table</B></PRE> |
| <DL> |
| <DD>(Optional) Name of table that stores the generated id values. |
| <p> Defaults to a name chosen by persistence provider. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <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="pkColumnName()"><!-- --></A><H3> |
| pkColumnName</H3> |
| <PRE> |
| public abstract java.lang.String <B>pkColumnName</B></PRE> |
| <DL> |
| <DD>(Optional) Name of the primary key column in the table. |
| <p> Defaults to a provider-chosen name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="valueColumnName()"><!-- --></A><H3> |
| valueColumnName</H3> |
| <PRE> |
| public abstract java.lang.String <B>valueColumnName</B></PRE> |
| <DL> |
| <DD>(Optional) Name of the column that stores the last value generated. |
| <p> Defaults to a provider-chosen name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="pkColumnValue()"><!-- --></A><H3> |
| pkColumnValue</H3> |
| <PRE> |
| public abstract java.lang.String <B>pkColumnValue</B></PRE> |
| <DL> |
| <DD>(Optional) The primary key value in the generator table |
| that distinguishes this set of generated values from others |
| that may be stored in the table. |
| <p> Defaults to a provider-chosen value to store in the |
| primary key column of the generator table |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="initialValue()"><!-- --></A><H3> |
| initialValue</H3> |
| <PRE> |
| public abstract int <B>initialValue</B></PRE> |
| <DL> |
| <DD>(Optional) The initial value to be used when allocating id |
| numbers from the generator. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>0</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allocationSize()"><!-- --></A><H3> |
| allocationSize</H3> |
| <PRE> |
| public abstract int <B>allocationSize</B></PRE> |
| <DL> |
| <DD>(Optional) The amount to increment by when allocating id |
| numbers from the generator. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>50</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 only used if table generation is in effect. |
| These constraints apply in addition to primary key constraints. |
| <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.1.3, build 'v20090925-r5281' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/Table.html" title="annotation in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/Temporal.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/TableGenerator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="TableGenerator.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> |
