| <!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_01) on Tue Mar 18 12:42:25 PDT 2008 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| Persistent (JDO2 API 2.1) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2008-03-18"> |
| |
| <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="Persistent (JDO2 API 2.1)"; |
| } |
| } |
| </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="class-use/Persistent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/annotations/PrimaryKey.html" title="annotation in javax.jdo.annotations"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/annotations/Persistent.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Persistent.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.jdo.annotations</FONT> |
| <BR> |
| Annotation Type Persistent</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1">@Target(value={FIELD,METHOD}) |
| @Retention(value=RUNTIME) |
| </FONT>public @interface <B>Persistent</B></DL> |
| </PRE> |
| |
| <P> |
| Annotation for defining the persistence of a member. |
| This corresponds to the xml elements "field" and "property". |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.1</DD> |
| <DT><B>Version:</B></DT> |
| <DD>2.1</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/jdo/annotations/Persistent.html#column()">column</A></B></CODE> |
| |
| <BR> |
| Column name where the values are stored for this member.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/Column.html" title="annotation in javax.jdo.annotations">Column</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Persistent.html#columns()">columns</A></B></CODE> |
| |
| <BR> |
| Column definition(s) for this member.</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/jdo/annotations/Persistent.html#customValueStrategy()">customValueStrategy</A></B></CODE> |
| |
| <BR> |
| Custom value strategy to use to generate the value for this field |
| or property (if any).</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/jdo/annotations/Persistent.html#defaultFetchGroup()">defaultFetchGroup</A></B></CODE> |
| |
| <BR> |
| Whether this member is in the default fetch group.</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/jdo/annotations/Persistent.html#dependent()">dependent</A></B></CODE> |
| |
| <BR> |
| Whether related object(s) of this member are dependent |
| and so deleted when this object is deleted.</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/jdo/annotations/Persistent.html#dependentElement()">dependentElement</A></B></CODE> |
| |
| <BR> |
| Whether the elements of this member are dependent.</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/jdo/annotations/Persistent.html#dependentKey()">dependentKey</A></B></CODE> |
| |
| <BR> |
| Whether the keys of this member are dependent.</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/jdo/annotations/Persistent.html#dependentValue()">dependentValue</A></B></CODE> |
| |
| <BR> |
| Whether the values of this member are dependent.</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/jdo/annotations/Persistent.html#embedded()">embedded</A></B></CODE> |
| |
| <BR> |
| Whether this member is embedded.</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/jdo/annotations/Persistent.html#embeddedElement()">embeddedElement</A></B></CODE> |
| |
| <BR> |
| Whether the elements of this member are embedded.</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/jdo/annotations/Persistent.html#embeddedKey()">embeddedKey</A></B></CODE> |
| |
| <BR> |
| Whether the keys of this member are embedded.</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/jdo/annotations/Persistent.html#embeddedValue()">embeddedValue</A></B></CODE> |
| |
| <BR> |
| Whether the values of this member are embedded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Persistent.html#extensions()">extensions</A></B></CODE> |
| |
| <BR> |
| Vendor extensions for this member.</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/jdo/annotations/Persistent.html#loadFetchGroup()">loadFetchGroup</A></B></CODE> |
| |
| <BR> |
| Name of the fetch-group to use when this member is loaded |
| due to being referenced when not already loaded.</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/jdo/annotations/Persistent.html#mappedBy()">mappedBy</A></B></CODE> |
| |
| <BR> |
| Name of the related member in the other class |
| where this value is mapped (bidirectional relationship).</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/jdo/annotations/Persistent.html#name()">name</A></B></CODE> |
| |
| <BR> |
| Name of the member when this is embedded in another object.</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/jdo/annotations/Persistent.html#nullIndicatorColumn()">nullIndicatorColumn</A></B></CODE> |
| |
| <BR> |
| Null indicator column for this member.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/NullValue.html" title="enum in javax.jdo.annotations">NullValue</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Persistent.html#nullValue()">nullValue</A></B></CODE> |
| |
| <BR> |
| Behavior when this member contains a null value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations">PersistenceModifier</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Persistent.html#persistenceModifier()">persistenceModifier</A></B></CODE> |
| |
| <BR> |
| Modifier for this field.</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/jdo/annotations/Persistent.html#primaryKey()">primaryKey</A></B></CODE> |
| |
| <BR> |
| Whether this member is part of the primary key for application |
| identity.</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/jdo/annotations/Persistent.html#recursionDepth()">recursionDepth</A></B></CODE> |
| |
| <BR> |
| Recursion depth for this member.</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/jdo/annotations/Persistent.html#sequence()">sequence</A></B></CODE> |
| |
| <BR> |
| Name of the sequence to use with particular value strategies.</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/jdo/annotations/Persistent.html#serialized()">serialized</A></B></CODE> |
| |
| <BR> |
| Whether this member is serialized into a single column.</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/jdo/annotations/Persistent.html#serializedElement()">serializedElement</A></B></CODE> |
| |
| <BR> |
| Whether the elements of this member are serialized.</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/jdo/annotations/Persistent.html#serializedKey()">serializedKey</A></B></CODE> |
| |
| <BR> |
| Whether the keys of this member are serialized.</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/jdo/annotations/Persistent.html#serializedValue()">serializedValue</A></B></CODE> |
| |
| <BR> |
| Whether the values of this member are serialized.</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/jdo/annotations/Persistent.html#table()">table</A></B></CODE> |
| |
| <BR> |
| Table to use for persisting this member.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Class[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Persistent.html#types()">types</A></B></CODE> |
| |
| <BR> |
| Types of the member.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/IdGeneratorStrategy.html" title="enum in javax.jdo.annotations">IdGeneratorStrategy</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Persistent.html#valueStrategy()">valueStrategy</A></B></CODE> |
| |
| <BR> |
| Value strategy to use to generate the value for this field |
| or property (if any).</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| <A NAME="persistenceModifier()"><!-- --></A><H3> |
| persistenceModifier</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations">PersistenceModifier</A> <B>persistenceModifier</B></PRE> |
| <DL> |
| <DD>Modifier for this field. This is normally not specified, and the |
| defaults are used, or the @Transactional or @NotPersistent |
| annotation is specified directly on the member. One possible use |
| for specifying persistenceModifier is for embedded instances in which |
| a member is not persistent but in the non-embedded instances the |
| member is persistent. Note that it is not portable to specify a |
| member to be not persistent in the non-embedded case and persistent |
| in the embedded usage. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the persistence modifier</DL> |
| <DL> |
| <DT><B>Default:</B><DD>javax.jdo.annotations.PersistenceModifier.UNSPECIFIED</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="table()"><!-- --></A><H3> |
| table</H3> |
| <PRE> |
| public abstract java.lang.String <B>table</B></PRE> |
| <DL> |
| <DD>Table to use for persisting this member. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the table to use for persisting this member</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="defaultFetchGroup()"><!-- --></A><H3> |
| defaultFetchGroup</H3> |
| <PRE> |
| public abstract java.lang.String <B>defaultFetchGroup</B></PRE> |
| <DL> |
| <DD>Whether this member is in the default fetch group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether this member is in the default fetch group</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="nullValue()"><!-- --></A><H3> |
| nullValue</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/jdo/annotations/NullValue.html" title="enum in javax.jdo.annotations">NullValue</A> <B>nullValue</B></PRE> |
| <DL> |
| <DD>Behavior when this member contains a null value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the behavior when this member contains a null value</DL> |
| <DL> |
| <DT><B>Default:</B><DD>javax.jdo.annotations.NullValue.NONE</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="embedded()"><!-- --></A><H3> |
| embedded</H3> |
| <PRE> |
| public abstract java.lang.String <B>embedded</B></PRE> |
| <DL> |
| <DD>Whether this member is embedded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether this member is embedded</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="embeddedElement()"><!-- --></A><H3> |
| embeddedElement</H3> |
| <PRE> |
| public abstract java.lang.String <B>embeddedElement</B></PRE> |
| <DL> |
| <DD>Whether the elements of this member are embedded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the elements of this member are embedded</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="embeddedKey()"><!-- --></A><H3> |
| embeddedKey</H3> |
| <PRE> |
| public abstract java.lang.String <B>embeddedKey</B></PRE> |
| <DL> |
| <DD>Whether the keys of this member are embedded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the keys of this member are embedded</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="embeddedValue()"><!-- --></A><H3> |
| embeddedValue</H3> |
| <PRE> |
| public abstract java.lang.String <B>embeddedValue</B></PRE> |
| <DL> |
| <DD>Whether the values of this member are embedded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the values of this member are embedded</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="serialized()"><!-- --></A><H3> |
| serialized</H3> |
| <PRE> |
| public abstract java.lang.String <B>serialized</B></PRE> |
| <DL> |
| <DD>Whether this member is serialized into a single column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether this member is serialized into a single column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="serializedElement()"><!-- --></A><H3> |
| serializedElement</H3> |
| <PRE> |
| public abstract java.lang.String <B>serializedElement</B></PRE> |
| <DL> |
| <DD>Whether the elements of this member are serialized. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the elements of this member are serialized</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="serializedKey()"><!-- --></A><H3> |
| serializedKey</H3> |
| <PRE> |
| public abstract java.lang.String <B>serializedKey</B></PRE> |
| <DL> |
| <DD>Whether the keys of this member are serialized. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the keys of this member are serialized</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="serializedValue()"><!-- --></A><H3> |
| serializedValue</H3> |
| <PRE> |
| public abstract java.lang.String <B>serializedValue</B></PRE> |
| <DL> |
| <DD>Whether the values of this member are serialized. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the values of this member are serialized</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dependent()"><!-- --></A><H3> |
| dependent</H3> |
| <PRE> |
| public abstract java.lang.String <B>dependent</B></PRE> |
| <DL> |
| <DD>Whether related object(s) of this member are dependent |
| and so deleted when this object is deleted. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the related object(s) of this member |
| are dependent</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dependentElement()"><!-- --></A><H3> |
| dependentElement</H3> |
| <PRE> |
| public abstract java.lang.String <B>dependentElement</B></PRE> |
| <DL> |
| <DD>Whether the elements of this member are dependent. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the elements of this member are dependent</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dependentKey()"><!-- --></A><H3> |
| dependentKey</H3> |
| <PRE> |
| public abstract java.lang.String <B>dependentKey</B></PRE> |
| <DL> |
| <DD>Whether the keys of this member are dependent. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the keys of this member are dependent</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dependentValue()"><!-- --></A><H3> |
| dependentValue</H3> |
| <PRE> |
| public abstract java.lang.String <B>dependentValue</B></PRE> |
| <DL> |
| <DD>Whether the values of this member are dependent. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the values of this member are dependent</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="primaryKey()"><!-- --></A><H3> |
| primaryKey</H3> |
| <PRE> |
| public abstract java.lang.String <B>primaryKey</B></PRE> |
| <DL> |
| <DD>Whether this member is part of the primary key for application |
| identity. This is equivalent to specifying @PrimaryKey as |
| a separate annotation on the member. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether this member is part of the primary key</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="valueStrategy()"><!-- --></A><H3> |
| valueStrategy</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/jdo/annotations/IdGeneratorStrategy.html" title="enum in javax.jdo.annotations">IdGeneratorStrategy</A> <B>valueStrategy</B></PRE> |
| <DL> |
| <DD>Value strategy to use to generate the value for this field |
| or property (if any). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the generated value strategy</DL> |
| <DL> |
| <DT><B>Default:</B><DD>javax.jdo.annotations.IdGeneratorStrategy.UNSPECIFIED</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="customValueStrategy()"><!-- --></A><H3> |
| customValueStrategy</H3> |
| <PRE> |
| public abstract java.lang.String <B>customValueStrategy</B></PRE> |
| <DL> |
| <DD>Custom value strategy to use to generate the value for this field |
| or property (if any). If customValueStrategy is non-empty, then |
| valueStrategy must be UNSPECIFIED. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the custom value strategy</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="sequence()"><!-- --></A><H3> |
| sequence</H3> |
| <PRE> |
| public abstract java.lang.String <B>sequence</B></PRE> |
| <DL> |
| <DD>Name of the sequence to use with particular value strategies. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of the sequence</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="loadFetchGroup()"><!-- --></A><H3> |
| loadFetchGroup</H3> |
| <PRE> |
| public abstract java.lang.String <B>loadFetchGroup</B></PRE> |
| <DL> |
| <DD>Name of the fetch-group to use when this member is loaded |
| due to being referenced when not already loaded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of the load fetch group</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="types()"><!-- --></A><H3> |
| types</H3> |
| <PRE> |
| public abstract java.lang.Class[] <B>types</B></PRE> |
| <DL> |
| <DD>Types of the member. Used when the declared |
| member type is a supertype of the actual type that is stored in the |
| member. For example, the declared member type might be an interface type |
| that must contain an object of a concrete type when used |
| for persistence. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the types</DL> |
| <DL> |
| <DT><B>Default:</B><DD>{}</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="mappedBy()"><!-- --></A><H3> |
| mappedBy</H3> |
| <PRE> |
| public abstract java.lang.String <B>mappedBy</B></PRE> |
| <DL> |
| <DD>Name of the related member in the other class |
| where this value is mapped (bidirectional relationship). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the related member in the other class</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="columns()"><!-- --></A><H3> |
| columns</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/jdo/annotations/Column.html" title="annotation in javax.jdo.annotations">Column</A>[] <B>columns</B></PRE> |
| <DL> |
| <DD>Column definition(s) for this member. Used for mapping |
| multiple columns |
| to the same member, for example relationships with |
| multiple column foreign keys. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the columns for this member</DL> |
| <DL> |
| <DT><B>Default:</B><DD>{}</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="column()"><!-- --></A><H3> |
| column</H3> |
| <PRE> |
| public abstract java.lang.String <B>column</B></PRE> |
| <DL> |
| <DD>Column name where the values are stored for this member. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of the column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="nullIndicatorColumn()"><!-- --></A><H3> |
| nullIndicatorColumn</H3> |
| <PRE> |
| public abstract java.lang.String <B>nullIndicatorColumn</B></PRE> |
| <DL> |
| <DD>Null indicator column for this member. Used for nested |
| embedded fields or properties to indicate whether the embedded |
| instance should have a null value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the null indicator column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="name()"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| public abstract java.lang.String <B>name</B></PRE> |
| <DL> |
| <DD>Name of the member when this is embedded in another object. |
| The fully-qualified member name is used. For example, |
| "line.point1.x" refers to the member x in class Point |
| that is embedded as member point1 in class Line that is embedded |
| in a member called line. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of the member</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="recursionDepth()"><!-- --></A><H3> |
| recursionDepth</H3> |
| <PRE> |
| public abstract int <B>recursionDepth</B></PRE> |
| <DL> |
| <DD>Recursion depth for this member. Used only when |
| the annotation is used within the definition of a FetchGroup. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the recursion depth</DL> |
| <DL> |
| <DT><B>Default:</B><DD>1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="extensions()"><!-- --></A><H3> |
| extensions</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</A>[] <B>extensions</B></PRE> |
| <DL> |
| <DD>Vendor extensions for this member. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the vendor extensions</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="class-use/Persistent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../javax/jdo/annotations/PersistenceModifier.html" title="enum in javax.jdo.annotations"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/annotations/PrimaryKey.html" title="annotation in javax.jdo.annotations"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/annotations/Persistent.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Persistent.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> |
| Copyright © 2005-2008 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
