| <!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 Nov 27 12:46:11 EST 2009 --> |
| <TITLE> |
| GeneratedValue (EclipseLink 2.0.0, build 'v20091127-r5931' API Reference) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-11-27"> |
| |
| <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="GeneratedValue (EclipseLink 2.0.0, build 'v20091127-r5931' 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 2.0.0, build 'v20091127-r5931' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/FlushModeType.html" title="enum in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/GenerationType.html" title="enum in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/persistence/GeneratedValue.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="GeneratedValue.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: REQUIRED | <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 GeneratedValue</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1">@Target(value={METHOD,FIELD}) |
| @Retention(value=RUNTIME) |
| </FONT>public @interface <B>GeneratedValue</B></DL> |
| </PRE> |
| |
| <P> |
| Provides for the specification of generation strategies for the |
| values of primary keys. |
| |
| <p> The <code>GeneratedValue</code> annotation |
| may be applied to a primary key property or field of an entity or |
| mapped superclass in conjunction with the <A HREF="../../javax/persistence/Id.html" title="annotation in javax.persistence"><CODE>Id</CODE></A> annotation. |
| The use of the <code>GeneratedValue</code> annotation is only |
| required to be supported for simple primary keys. Use of the |
| <code>GeneratedValue</code> annotation is not supported for derived |
| primary keys. |
| |
| <pre> |
| |
| Example 1: |
| |
| @Id |
| @GeneratedValue(strategy=SEQUENCE, generator="CUST_SEQ") |
| @Column(name="CUST_ID") |
| public Long getId() { return id; } |
| |
| Example 2: |
| |
| @Id |
| @GeneratedValue(strategy=TABLE, generator="CUST_GEN") |
| @Column(name="CUST_ID") |
| Long id; |
| </pre> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../javax/persistence/Id.html" title="annotation in javax.persistence"><CODE>Id</CODE></A>, |
| <A HREF="../../javax/persistence/TableGenerator.html" title="annotation in javax.persistence"><CODE>TableGenerator</CODE></A>, |
| <A HREF="../../javax/persistence/SequenceGenerator.html" title="annotation in javax.persistence"><CODE>SequenceGenerator</CODE></A><DT><B>Since:</B></DT> |
| <DD>Java Persistence 1.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== 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/GeneratedValue.html#generator()">generator</A></B></CODE> |
| |
| <BR> |
| (Optional) The name of the primary key generator |
| to use as specified in the <A HREF="../../javax/persistence/SequenceGenerator.html" title="annotation in javax.persistence"><CODE>SequenceGenerator</CODE></A> |
| or <A HREF="../../javax/persistence/TableGenerator.html" title="annotation in javax.persistence"><CODE>TableGenerator</CODE></A> annotation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/persistence/GenerationType.html" title="enum in javax.persistence">GenerationType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/GeneratedValue.html#strategy()">strategy</A></B></CODE> |
| |
| <BR> |
| (Optional) The primary key generation strategy |
| that the persistence provider must use to |
| generate the annotated entity primary key.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| <A NAME="strategy()"><!-- --></A><H3> |
| strategy</H3> |
| <PRE> |
| public abstract <A HREF="../../javax/persistence/GenerationType.html" title="enum in javax.persistence">GenerationType</A> <B>strategy</B></PRE> |
| <DL> |
| <DD>(Optional) The primary key generation strategy |
| that the persistence provider must use to |
| generate the annotated entity primary key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| <DL> |
| <DT><B>Default:</B><DD>javax.persistence.GenerationType.AUTO</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="generator()"><!-- --></A><H3> |
| generator</H3> |
| <PRE> |
| public abstract java.lang.String <B>generator</B></PRE> |
| <DL> |
| <DD>(Optional) The name of the primary key generator |
| to use as specified in the <A HREF="../../javax/persistence/SequenceGenerator.html" title="annotation in javax.persistence"><CODE>SequenceGenerator</CODE></A> |
| or <A HREF="../../javax/persistence/TableGenerator.html" title="annotation in javax.persistence"><CODE>TableGenerator</CODE></A> annotation. |
| <p> Defaults to the id generator supplied by persistence provider. |
| <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 2.0.0, build 'v20091127-r5931' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/FlushModeType.html" title="enum in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/GenerationType.html" title="enum in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/persistence/GeneratedValue.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="GeneratedValue.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: REQUIRED | <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> |
