http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/ObjectId.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/ObjectId.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/ObjectId.html new file mode 100644 index 0000000..e8ac2bb --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/ObjectId.html @@ -0,0 +1,883 @@ +<!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.5.0_06) on Wed Jul 19 14:42:40 EDT 2006 --> +<TITLE> +ObjectId (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.ObjectId class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ObjectId (Cayenne API Documentation - v.1.2)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= 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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/PersistenceState.html" title="class in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/ObjectId.html" target="_top"><B>FRAMES</B></A> + <A HREF="ObjectId.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne</FONT> +<BR> +Class ObjectId</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.ObjectId</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/objectstyle/cayenne/TempObjectId.html" title="class in org.objectstyle.cayenne">TempObjectId</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>ObjectId</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> +</PRE> + +<P> +A portable global identifier for persistent objects. ObjectId can be temporary (used + for transient or new uncommitted objects) or permanent (used for objects that have been + already stored in DB). A temporary ObjectId stores object entity name and a + pseudo-unique binary key; permanent id stores a map of values from an external + persistent store (aka "primary key"). +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.objectstyle.cayenne.ObjectId">Serialized Form</A></DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_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>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#entityName">entityName</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#key">key</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#objectIdKeys">objectIdKeys</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#replacementIdMap">replacementIdMap</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.Class)">ObjectId</A></B>(java.lang.Class objectClass)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.Class, java.util.Map)">ObjectId</A></B>(java.lang.Class objectClass, + java.util.Map idKeys)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.Class, java.lang.String, int)">ObjectId</A></B>(java.lang.Class objectClass, + java.lang.String keyName, + int id)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.Class, java.lang.String, java.lang.Object)">ObjectId</A></B>(java.lang.Class objectClass, + java.lang.String keyName, + java.lang.Object id)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.String)">ObjectId</A></B>(java.lang.String entityName)</CODE> + +<BR> + Creates a TEMPORARY ObjectId.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.String, byte[])">ObjectId</A></B>(java.lang.String entityName, + byte[] key)</CODE> + +<BR> + Creates a TEMPORARY id with a specified entity name and a binary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.String, java.util.Map)">ObjectId</A></B>(java.lang.String entityName, + java.util.Map idMap)</CODE> + +<BR> + Creates a portable permanent ObjectId.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.String, java.lang.String, int)">ObjectId</A></B>(java.lang.String entityName, + java.lang.String key, + int value)</CODE> + +<BR> + Creates a portable permanent ObjectId.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#ObjectId(java.lang.String, java.lang.String, java.lang.Object)">ObjectId</A></B>(java.lang.String entityName, + java.lang.String key, + java.lang.Object value)</CODE> + +<BR> + Creates a portable permanent ObjectId.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_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>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#createReplacementId()">createReplacementId</A></B>()</CODE> + +<BR> + Creates and returns a replacement ObjectId.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object object)</CODE> + +<BR> + </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="../../../org/objectstyle/cayenne/ObjectId.html#getEntityName()">getEntityName</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getIdSnapshot()">getIdSnapshot</A></B>()</CODE> + +<BR> + Returns an unmodifiable Map of persistent id values, essentailly a primary key map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getKey()">getKey</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getReplacementId()">getReplacementId</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> <I>Since 1.2 replacement id is built by appending to replacementIdMap.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getReplacementIdMap()">getReplacementIdMap</A></B>()</CODE> + +<BR> + Returns a non-null mutable map that can be used to append replacement id values.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getValueForAttribute(java.lang.String)">getValueForAttribute</A></B>(java.lang.String attrName)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2. This method is redundant. Use + <code>getIdSnapshot().get(attrName)</code> instead.</I></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="../../../org/objectstyle/cayenne/ObjectId.html#hashCode()">hashCode</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#isReplacementIdAttached()">isReplacementIdAttached</A></B>()</CODE> + +<BR> + Returns true if there is full or partial replacement id attached to this id.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#isTemporary()">isTemporary</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#setIdKeys(java.util.Map)">setIdKeys</A></B>(java.util.Map idKeys)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#setReplacementId(org.objectstyle.cayenne.ObjectId)">setReplacementId</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> replacementId)</CODE> + +<BR> + <B>Deprecated.</B> <I>Since 1.2 replacement id is built by appending to replacementIdMap.</I></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="../../../org/objectstyle/cayenne/ObjectId.html#toString()">toString</A></B>()</CODE> + +<BR> + A standard toString method used for debugging.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_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>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="entityName"><!-- --></A><H3> +entityName</H3> +<PRE> +protected java.lang.String <B>entityName</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="objectIdKeys"><!-- --></A><H3> +objectIdKeys</H3> +<PRE> +protected java.util.Map <B>objectIdKeys</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="key"><!-- --></A><H3> +key</H3> +<PRE> +protected byte[] <B>key</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="replacementIdMap"><!-- --></A><H3> +replacementIdMap</H3> +<PRE> +protected java.util.Map <B>replacementIdMap</B></PRE> +<DL> +<DL> +</DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ObjectId(java.lang.String)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.String entityName)</PRE> +<DL> +<DD>Creates a TEMPORARY ObjectId. Assignes a generated unique key. +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.String, byte[])"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.String entityName, + byte[] key)</PRE> +<DL> +<DD>Creates a TEMPORARY id with a specified entity name and a binary key. It is a + caller responsibility to provide a globally unique binary key. +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.String, java.lang.String, int)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.String entityName, + java.lang.String key, + int value)</PRE> +<DL> +<DD>Creates a portable permanent ObjectId. +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.String entityName, + java.lang.String key, + java.lang.Object value)</PRE> +<DL> +<DD>Creates a portable permanent ObjectId. +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.String, java.util.Map)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.String entityName, + java.util.Map idMap)</PRE> +<DL> +<DD>Creates a portable permanent ObjectId. +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.Class)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.Class objectClass)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I> +<P> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.Class, java.lang.String, int)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.Class objectClass, + java.lang.String keyName, + int id)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I> +<P> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.Class, java.lang.String, java.lang.Object)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.Class objectClass, + java.lang.String keyName, + java.lang.Object id)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I> +<P> +</DL> +<HR> + +<A NAME="ObjectId(java.lang.Class, java.util.Map)"><!-- --></A><H3> +ObjectId</H3> +<PRE> +public <B>ObjectId</B>(java.lang.Class objectClass, + java.util.Map idKeys)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. This constructor relies on default CayenneModeler + naming convention to figure out entity name from class name. This may + not work if the classes where mapped differently.</I> +<P> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_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>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="isTemporary()"><!-- --></A><H3> +isTemporary</H3> +<PRE> +public boolean <B>isTemporary</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getEntityName()"><!-- --></A><H3> +getEntityName</H3> +<PRE> +public java.lang.String <B>getEntityName</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getKey()"><!-- --></A><H3> +getKey</H3> +<PRE> +public byte[] <B>getKey</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setIdKeys(java.util.Map)"><!-- --></A><H3> +setIdKeys</H3> +<PRE> +protected void <B>setIdKeys</B>(java.util.Map idKeys)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getIdSnapshot()"><!-- --></A><H3> +getIdSnapshot</H3> +<PRE> +public java.util.Map <B>getIdSnapshot</B>()</PRE> +<DL> +<DD>Returns an unmodifiable Map of persistent id values, essentailly a primary key map. + For temporary id returns replacement id, if it was already created. Otherwise + returns an empty map. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getValueForAttribute(java.lang.String)"><!-- --></A><H3> +getValueForAttribute</H3> +<PRE> +public java.lang.Object <B>getValueForAttribute</B>(java.lang.String attrName)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2. This method is redundant. Use + <code>getIdSnapshot().get(attrName)</code> instead.</I> +<P> +<DD>Returns a value of id attribute identified by the name of DbAttribute. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(java.lang.Object)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(java.lang.Object object)</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="hashCode()"><!-- --></A><H3> +hashCode</H3> +<PRE> +public int <B>hashCode</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getReplacementId()"><!-- --></A><H3> +getReplacementId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>getReplacementId</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <I>Since 1.2 replacement id is built by appending to replacementIdMap.</I> +<P> +<DD>Returns a replacement ObjectId associated with this id. Replacement ObjectId is + either a permananent ObjectId for an uncommitted object or a new id for object + whose id depends on its relationships. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setReplacementId(org.objectstyle.cayenne.ObjectId)"><!-- --></A><H3> +setReplacementId</H3> +<PRE> +public void <B>setReplacementId</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> replacementId)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>Since 1.2 replacement id is built by appending to replacementIdMap.</I> +<P> +<DD>Initializes a replacement ObjectId. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getReplacementIdMap()"><!-- --></A><H3> +getReplacementIdMap</H3> +<PRE> +public java.util.Map <B>getReplacementIdMap</B>()</PRE> +<DL> +<DD>Returns a non-null mutable map that can be used to append replacement id values. + This allows to incrementally build a replacement GlobalID. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createReplacementId()"><!-- --></A><H3> +createReplacementId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createReplacementId</B>()</PRE> +<DL> +<DD>Creates and returns a replacement ObjectId. No validation of ID is done. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isReplacementIdAttached()"><!-- --></A><H3> +isReplacementIdAttached</H3> +<PRE> +public boolean <B>isReplacementIdAttached</B>()</PRE> +<DL> +<DD>Returns true if there is full or partial replacement id attached to this id. This + method is preferrable to "!getReplacementIdMap().isEmpty()" as it avoids unneeded + replacement id map creation. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD>A standard toString method used for debugging. +<P> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/PersistenceState.html" title="class in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/ObjectId.html" target="_top"><B>FRAMES</B></A> + <A HREF="ObjectId.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistenceState.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistenceState.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistenceState.html new file mode 100644 index 0000000..677846f --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistenceState.html @@ -0,0 +1,423 @@ +<!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.5.0_06) on Wed Jul 19 14:42:41 EDT 2006 --> +<TITLE> +PersistenceState (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.PersistenceState class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="PersistenceState (Cayenne API Documentation - v.1.2)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= 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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/PersistenceState.html" target="_top"><B>FRAMES</B></A> + <A HREF="PersistenceState.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne</FONT> +<BR> +Class PersistenceState</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.PersistenceState</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>PersistenceState</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Defines a set of object states from the point of view of persistence. I.e. + PersistenceState is the state of data stored in an object relative to the external + persistence store. If an object's state matches the state of the persistence store, the + object is COMMITTED. If object is not intended to be persistent or is not explicitly + made persistent, the state is TRANSIENT, and so on. + <p> + Object persistence states should not be modified directly. Rather it is a + responsibility of a ObjectContext/DataContext to maintain correct state of the managed + objects. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +</DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_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>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#COMMITTED">COMMITTED</A></B></CODE> + +<BR> + Describes a state of an object registered with DataContext/ObjectContext, whose + fields exactly match the state of a corresponding database row.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#DELETED">DELETED</A></B></CODE> + +<BR> + Describes a state of an object registered with DataContext/ObjectContext, that will + be deleted from the database on the next commit.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#HOLLOW">HOLLOW</A></B></CODE> + +<BR> + Describes a state of an object registered with DataContext/ObjectContext, and + having a corresponding database row.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#MODIFIED">MODIFIED</A></B></CODE> + +<BR> + Describes a state of an object registered with DataContext/ObjectContext, and + having a corresponding database row.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#NEW">NEW</A></B></CODE> + +<BR> + Describes a state of an object freshly registered with DataContext/ObjectContext, + but not committed to the database yet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#TRANSIENT">TRANSIENT</A></B></CODE> + +<BR> + Describes a state of an object not registered with DataContext/ObjectContext, and + therefore having no persistence features.</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#PersistenceState()">PersistenceState</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_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>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistenceState.html#persistenceStateName(int)">persistenceStateName</A></B>(int persistenceState)</CODE> + +<BR> + Returns String label for persistence state.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_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>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="TRANSIENT"><!-- --></A><H3> +TRANSIENT</H3> +<PRE> +public static final int <B>TRANSIENT</B></PRE> +<DL> +<DD>Describes a state of an object not registered with DataContext/ObjectContext, and + therefore having no persistence features. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.PersistenceState.TRANSIENT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="NEW"><!-- --></A><H3> +NEW</H3> +<PRE> +public static final int <B>NEW</B></PRE> +<DL> +<DD>Describes a state of an object freshly registered with DataContext/ObjectContext, + but not committed to the database yet. So there is no corresponding database record + for this object just yet. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.PersistenceState.NEW">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="COMMITTED"><!-- --></A><H3> +COMMITTED</H3> +<PRE> +public static final int <B>COMMITTED</B></PRE> +<DL> +<DD>Describes a state of an object registered with DataContext/ObjectContext, whose + fields exactly match the state of a corresponding database row. This state is not + fully "clean", since database record may have been externally modified. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.PersistenceState.COMMITTED">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="MODIFIED"><!-- --></A><H3> +MODIFIED</H3> +<PRE> +public static final int <B>MODIFIED</B></PRE> +<DL> +<DD>Describes a state of an object registered with DataContext/ObjectContext, and + having a corresponding database row. This object state is known to be locally + modified and different from the database state. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.PersistenceState.MODIFIED">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HOLLOW"><!-- --></A><H3> +HOLLOW</H3> +<PRE> +public static final int <B>HOLLOW</B></PRE> +<DL> +<DD>Describes a state of an object registered with DataContext/ObjectContext, and + having a corresponding database row. This object does not store any fields except + for its id (it is "hollow"), so next time it is accessed, it will be populated from + the database by the context. In this respect this is a real "clean" object. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.PersistenceState.HOLLOW">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="DELETED"><!-- --></A><H3> +DELETED</H3> +<PRE> +public static final int <B>DELETED</B></PRE> +<DL> +<DD>Describes a state of an object registered with DataContext/ObjectContext, that will + be deleted from the database on the next commit. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.PersistenceState.DELETED">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="PersistenceState()"><!-- --></A><H3> +PersistenceState</H3> +<PRE> +public <B>PersistenceState</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_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>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="persistenceStateName(int)"><!-- --></A><H3> +persistenceStateName</H3> +<PRE> +public static java.lang.String <B>persistenceStateName</B>(int persistenceState)</PRE> +<DL> +<DD>Returns String label for persistence state. Used for debugging. +<P> +<DD><DL> +</DL> +</DD> +</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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/PersistenceState.html" target="_top"><B>FRAMES</B></A> + <A HREF="PersistenceState.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/Persistent.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/Persistent.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/Persistent.html new file mode 100644 index 0000000..fe2676b --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/Persistent.html @@ -0,0 +1,336 @@ +<!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.5.0_06) on Wed Jul 19 14:42:41 EDT 2006 --> +<TITLE> +Persistent (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.Persistent interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="Persistent (Cayenne API Documentation - v.1.2)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= 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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/PersistenceState.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/PersistentObject.html" title="class in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne</FONT> +<BR> +Interface Persistent</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<DL> +<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/objectstyle/cayenne/CayenneDataObject.html" title="class in org.objectstyle.cayenne">CayenneDataObject</A>, <A HREF="../../../org/objectstyle/cayenne/PersistentObject.html" title="class in org.objectstyle.cayenne">PersistentObject</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>Persistent</B><DT>extends java.io.Serializable</DL> +</PRE> + +<P> +Defines minimal API of an object that can be persisted via Cayenne. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +</DL> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_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>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/Persistent.html#getObjectContext()">getObjectContext</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/Persistent.html#getObjectId()">getObjectId</A></B>()</CODE> + +<BR> + </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="../../../org/objectstyle/cayenne/Persistent.html#getPersistenceState()">getPersistenceState</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/Persistent.html#setObjectContext(org.objectstyle.cayenne.ObjectContext)">setObjectContext</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> objectContext)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/Persistent.html#setObjectId(org.objectstyle.cayenne.ObjectId)">setObjectId</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> id)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/Persistent.html#setPersistenceState(int)">setPersistenceState</A></B>(int state)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_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>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getObjectId()"><!-- --></A><H3> +getObjectId</H3> +<PRE> +<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>getObjectId</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setObjectId(org.objectstyle.cayenne.ObjectId)"><!-- --></A><H3> +setObjectId</H3> +<PRE> +void <B>setObjectId</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> id)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getPersistenceState()"><!-- --></A><H3> +getPersistenceState</H3> +<PRE> +int <B>getPersistenceState</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setPersistenceState(int)"><!-- --></A><H3> +setPersistenceState</H3> +<PRE> +void <B>setPersistenceState</B>(int state)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getObjectContext()"><!-- --></A><H3> +getObjectContext</H3> +<PRE> +<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> <B>getObjectContext</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setObjectContext(org.objectstyle.cayenne.ObjectContext)"><!-- --></A><H3> +setObjectContext</H3> +<PRE> +void <B>setObjectContext</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> objectContext)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/PersistenceState.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/PersistentObject.html" title="class in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistentObject.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistentObject.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistentObject.html new file mode 100644 index 0000000..0a2e7c5 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/PersistentObject.html @@ -0,0 +1,479 @@ +<!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.5.0_06) on Wed Jul 19 14:42:41 EDT 2006 --> +<TITLE> +PersistentObject (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.PersistentObject class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="PersistentObject (Cayenne API Documentation - v.1.2)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= 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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/QueryResponse.html" title="interface in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/PersistentObject.html" target="_top"><B>FRAMES</B></A> + <A HREF="PersistentObject.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne</FONT> +<BR> +Class PersistentObject</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.PersistentObject</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public abstract class <B>PersistentObject</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></DL> +</PRE> + +<P> +A convenience base superclass for concrete Persistent objects. Provides implementation + of properties declared in Persistent interface. + <h4>POJO Note</h4> + <p> + If having PersistentObject as a superclass presents a problem in an application, source + code of this class can be copied verbatim to a custom class generation template. + Desired superclass can be set in CayenneModeler. + </p> +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.objectstyle.cayenne.PersistentObject">Serialized Form</A></DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_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>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected <A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#objectContext">objectContext</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#objectId">objectId</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#persistenceState">persistenceState</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#PersistentObject()">PersistentObject</A></B>()</CODE> + +<BR> + Creates a new transient object.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_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>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#getObjectContext()">getObjectContext</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#getObjectId()">getObjectId</A></B>()</CODE> + +<BR> + </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="../../../org/objectstyle/cayenne/PersistentObject.html#getPersistenceState()">getPersistenceState</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#setObjectContext(org.objectstyle.cayenne.ObjectContext)">setObjectContext</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> objectContext)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#setObjectId(org.objectstyle.cayenne.ObjectId)">setObjectId</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> objectId)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/PersistentObject.html#setPersistenceState(int)">setPersistenceState</A></B>(int persistenceState)</CODE> + +<BR> + </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="../../../org/objectstyle/cayenne/PersistentObject.html#toString()">toString</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_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>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="objectId"><!-- --></A><H3> +objectId</H3> +<PRE> +protected <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>objectId</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="persistenceState"><!-- --></A><H3> +persistenceState</H3> +<PRE> +protected int <B>persistenceState</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="objectContext"><!-- --></A><H3> +objectContext</H3> +<PRE> +protected transient <A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> <B>objectContext</B></PRE> +<DL> +<DL> +</DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="PersistentObject()"><!-- --></A><H3> +PersistentObject</H3> +<PRE> +public <B>PersistentObject</B>()</PRE> +<DL> +<DD>Creates a new transient object. +<P> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_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>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getPersistenceState()"><!-- --></A><H3> +getPersistenceState</H3> +<PRE> +public int <B>getPersistenceState</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#getPersistenceState()">getPersistenceState</A></CODE> in interface <CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setPersistenceState(int)"><!-- --></A><H3> +setPersistenceState</H3> +<PRE> +public void <B>setPersistenceState</B>(int persistenceState)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#setPersistenceState(int)">setPersistenceState</A></CODE> in interface <CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getObjectContext()"><!-- --></A><H3> +getObjectContext</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> <B>getObjectContext</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#getObjectContext()">getObjectContext</A></CODE> in interface <CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setObjectContext(org.objectstyle.cayenne.ObjectContext)"><!-- --></A><H3> +setObjectContext</H3> +<PRE> +public void <B>setObjectContext</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> objectContext)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#setObjectContext(org.objectstyle.cayenne.ObjectContext)">setObjectContext</A></CODE> in interface <CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getObjectId()"><!-- --></A><H3> +getObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>getObjectId</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#getObjectId()">getObjectId</A></CODE> in interface <CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setObjectId(org.objectstyle.cayenne.ObjectId)"><!-- --></A><H3> +setObjectId</H3> +<PRE> +public void <B>setObjectId</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> objectId)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#setObjectId(org.objectstyle.cayenne.ObjectId)">setObjectId</A></CODE> in interface <CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</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="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.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="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/QueryResponse.html" title="interface in org.objectstyle.cayenne"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/PersistentObject.html" target="_top"><B>FRAMES</B></A> + <A HREF="PersistentObject.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
