http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObject.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObject.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObject.html new file mode 100644 index 0000000..929d1e3 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObject.html @@ -0,0 +1,745 @@ +<!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> +DataObject (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.DataObject interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DataObject (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/DataChannelListener.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.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/DataObject.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataObject.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | 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 DataObject</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A>, java.io.Serializable</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></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>DataObject</B><DT>extends <A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></DL> +</PRE> + +<P> +Defines basic methods for a persistent object in Cayenne. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrei 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 long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObject.html#DEFAULT_VERSION">DEFAULT_VERSION</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> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObject.html#addToManyTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)">addToManyTarget</A></B>(java.lang.String relName, + <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> val, + boolean setReverse)</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/DataObject.html#fetchFinished()">fetchFinished</A></B>()</CODE> + +<BR> + Notification method called by DataContext after the object was read from the + database.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObject.html#getDataContext()">getDataContext</A></B>()</CODE> + +<BR> + Returns a data context this object is registered with, or null if this object has + no associated DataContext.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObject.html#getSnapshotVersion()">getSnapshotVersion</A></B>()</CODE> + +<BR> + Returns a version of a DataRow snapshot that was used to create this object.</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/DataObject.html#readNestedProperty(java.lang.String)">readNestedProperty</A></B>(java.lang.String path)</CODE> + +<BR> + Returns a value of the property identified by a property path.</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/DataObject.html#readProperty(java.lang.String)">readProperty</A></B>(java.lang.String propName)</CODE> + +<BR> + Returns a value of the property identified by propName.</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/DataObject.html#readPropertyDirectly(java.lang.String)">readPropertyDirectly</A></B>(java.lang.String propertyName)</CODE> + +<BR> + Returns mapped property value as curently stored in the DataObject.</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/DataObject.html#removeToManyTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)">removeToManyTarget</A></B>(java.lang.String relName, + <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> val, + boolean setReverse)</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/DataObject.html#resolveFault()">resolveFault</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2 use 'getObjectContext().prepareForAccess(object)'</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/DataObject.html#setDataContext(org.objectstyle.cayenne.access.DataContext)">setDataContext</A></B>(<A HREF="../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A> ctxt)</CODE> + +<BR> + Sets object DataContext.</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/DataObject.html#setSnapshotVersion(long)">setSnapshotVersion</A></B>(long snapshotVersion)</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/DataObject.html#setToOneTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)">setToOneTarget</A></B>(java.lang.String relationshipName, + <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> value, + boolean setReverse)</CODE> + +<BR> + Sets to-one relationship to a new value.</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/DataObject.html#validateForDelete(org.objectstyle.cayenne.validation.ValidationResult)">validateForDelete</A></B>(<A HREF="../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> validationResult)</CODE> + +<BR> + Performs property validation of the DELETED object, appending any validation + failures to the provided validationResult object.</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/DataObject.html#validateForInsert(org.objectstyle.cayenne.validation.ValidationResult)">validateForInsert</A></B>(<A HREF="../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> validationResult)</CODE> + +<BR> + Performs property validation of the NEW object, appending any validation failures + to the provided validationResult object.</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/DataObject.html#validateForUpdate(org.objectstyle.cayenne.validation.ValidationResult)">validateForUpdate</A></B>(<A HREF="../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> validationResult)</CODE> + +<BR> + Performs property validation of the MODIFIED object, appending any validation + failures to the provided validationResult object.</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/DataObject.html#writeProperty(java.lang.String, java.lang.Object)">writeProperty</A></B>(java.lang.String propertyName, + java.lang.Object value)</CODE> + +<BR> + Sets the property to the new value.</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/DataObject.html#writePropertyDirectly(java.lang.String, java.lang.Object)">writePropertyDirectly</A></B>(java.lang.String propertyName, + java.lang.Object val)</CODE> + +<BR> + Modifies a value of a named property without altering the object state in any way, + and without triggering any database operations.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.objectstyle.cayenne.Persistent"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface org.objectstyle.cayenne.<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../org/objectstyle/cayenne/Persistent.html#getObjectContext()">getObjectContext</A>, <A HREF="../../../org/objectstyle/cayenne/Persistent.html#getObjectId()">getObjectId</A>, <A HREF="../../../org/objectstyle/cayenne/Persistent.html#getPersistenceState()">getPersistenceState</A>, <A HREF="../../../org/objectstyle/cayenne/Persistent.html#setObjectContext(org.objectstyle.cayenne.ObjectContext)">setObjectContext</A>, <A HREF="../../../org/objectstyle/cayenne/Persistent.html#setObjectId(org.objectstyle.cayenne.ObjectId)">setObjectId</A>, <A HREF="../../../org/objectstyle/cayenne/Persistent.html#setPersistenceState(int)">setPersistenceState</A></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="DEFAULT_VERSION"><!-- --></A><H3> +DEFAULT_VERSION</H3> +<PRE> +static final long <B>DEFAULT_VERSION</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.objectstyle.cayenne.DataObject.DEFAULT_VERSION">Constant Field Values</A></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="getDataContext()"><!-- --></A><H3> +getDataContext</H3> +<PRE> +<A HREF="../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A> <B>getDataContext</B>()</PRE> +<DL> +<DD>Returns a data context this object is registered with, or null if this object has + no associated DataContext. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setDataContext(org.objectstyle.cayenne.access.DataContext)"><!-- --></A><H3> +setDataContext</H3> +<PRE> +void <B>setDataContext</B>(<A HREF="../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A> ctxt)</PRE> +<DL> +<DD>Sets object DataContext. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="writePropertyDirectly(java.lang.String, java.lang.Object)"><!-- --></A><H3> +writePropertyDirectly</H3> +<PRE> +void <B>writePropertyDirectly</B>(java.lang.String propertyName, + java.lang.Object val)</PRE> +<DL> +<DD>Modifies a value of a named property without altering the object state in any way, + and without triggering any database operations. This method is intended mostly for + internal use by Cayenne framework, and shouldn't be called from the application + code. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="readPropertyDirectly(java.lang.String)"><!-- --></A><H3> +readPropertyDirectly</H3> +<PRE> +java.lang.Object <B>readPropertyDirectly</B>(java.lang.String propertyName)</PRE> +<DL> +<DD>Returns mapped property value as curently stored in the DataObject. Returned value + maybe a fault or a real value. This method will not attempt to resolve faults, or + to read unmapped properties. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="readNestedProperty(java.lang.String)"><!-- --></A><H3> +readNestedProperty</H3> +<PRE> +java.lang.Object <B>readNestedProperty</B>(java.lang.String path)</PRE> +<DL> +<DD>Returns a value of the property identified by a property path. Supports reading + both mapped and unmapped properties. Unmapped properties are accessed in a manner + consistent with JavaBeans specification. + <p> + Property path (or nested property) is a dot-separated path used to traverse object + relationships until the final object is found. If a null object found while + traversing path, null is returned. If a list is encountered in the middle of the + path, CayenneRuntimeException is thrown. Unlike + <A HREF="../../../org/objectstyle/cayenne/DataObject.html#readPropertyDirectly(java.lang.String)"><CODE>readPropertyDirectly(String)</CODE></A>, this method will resolve an object if it is + HOLLOW. + <p> + Examples: + </p> + <ul> + <li>Read this object property:<br> + <code>String name = (String)artist.readNestedProperty("name");</code><br> + <br> + </li> + <li>Read an object related to this object:<br> + <code>Gallery g = (Gallery)paintingInfo.readNestedProperty("toPainting.toGallery");</code> + <br> + <br> + </li> + <li>Read a property of an object related to this object: <br> + <code>String name = (String)painting.readNestedProperty("toArtist.artistName");</code> + <br> + <br> + </li> + <li>Read to-many relationship list:<br> + <code>List exhibits = (List)painting.readNestedProperty("toGallery.exhibitArray");</code> + <br> + <br> + </li> + <li>Read to-many relationship in the middle of the path <b>(throws exception)</b>:<br> + <code>String name = (String)artist.readNestedProperty("paintingArray.paintingName");</code> + <br> + <br> + </li> + </ul> +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.0.5</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="readProperty(java.lang.String)"><!-- --></A><H3> +readProperty</H3> +<PRE> +java.lang.Object <B>readProperty</B>(java.lang.String propName)</PRE> +<DL> +<DD>Returns a value of the property identified by propName. Resolves faults if needed. + This method can safely be used instead of or in addition to the auto-generated + property accessors in subclasses of CayenneDataObject. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="writeProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> +writeProperty</H3> +<PRE> +void <B>writeProperty</B>(java.lang.String propertyName, + java.lang.Object value)</PRE> +<DL> +<DD>Sets the property to the new value. Resolves faults if needed. This method can be + safely used instead of or in addition to the auto-generated property modifiers to + set simple properties. Note that to set to-one relationships use + <A HREF="../../../org/objectstyle/cayenne/DataObject.html#setToOneTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)"><CODE>setToOneTarget(String, DataObject, boolean)</CODE></A>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>propertyName</CODE> - a name of the bean property being modified.<DD><CODE>value</CODE> - a new value of the property.</DL> +</DD> +</DL> +<HR> + +<A NAME="addToManyTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)"><!-- --></A><H3> +addToManyTarget</H3> +<PRE> +void <B>addToManyTarget</B>(java.lang.String relName, + <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> val, + boolean setReverse)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="removeToManyTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)"><!-- --></A><H3> +removeToManyTarget</H3> +<PRE> +void <B>removeToManyTarget</B>(java.lang.String relName, + <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> val, + boolean setReverse)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setToOneTarget(java.lang.String, org.objectstyle.cayenne.DataObject, boolean)"><!-- --></A><H3> +setToOneTarget</H3> +<PRE> +void <B>setToOneTarget</B>(java.lang.String relationshipName, + <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> value, + boolean setReverse)</PRE> +<DL> +<DD>Sets to-one relationship to a new value. Resolves faults if needed. This method can + safely be used instead of or in addition to the auto-generated property modifiers + to set properties that are to-one relationships. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>relationshipName</CODE> - a name of the bean property being modified - same as the + name of ObjRelationship.<DD><CODE>value</CODE> - a new value of the property.<DD><CODE>setReverse</CODE> - whether to update the reverse relationship pointing from the old + and new values of the property to this object.</DL> +</DD> +</DL> +<HR> + +<A NAME="fetchFinished()"><!-- --></A><H3> +fetchFinished</H3> +<PRE> +void <B>fetchFinished</B>()</PRE> +<DL> +<DD>Notification method called by DataContext after the object was read from the + database. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getSnapshotVersion()"><!-- --></A><H3> +getSnapshotVersion</H3> +<PRE> +long <B>getSnapshotVersion</B>()</PRE> +<DL> +<DD>Returns a version of a DataRow snapshot that was used to create this object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setSnapshotVersion(long)"><!-- --></A><H3> +setSnapshotVersion</H3> +<PRE> +void <B>setSnapshotVersion</B>(long snapshotVersion)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="resolveFault()"><!-- --></A><H3> +resolveFault</H3> +<PRE> +void <B>resolveFault</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2 use 'getObjectContext().prepareForAccess(object)'</I> +<P> +<DD>Initializes object with data from cache or from the database, if this object is not + fully resolved. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="validateForInsert(org.objectstyle.cayenne.validation.ValidationResult)"><!-- --></A><H3> +validateForInsert</H3> +<PRE> +void <B>validateForInsert</B>(<A HREF="../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> validationResult)</PRE> +<DL> +<DD>Performs property validation of the NEW object, appending any validation failures + to the provided validationResult object. This method is invoked by DataContext + before committing a NEW object to the database. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="validateForUpdate(org.objectstyle.cayenne.validation.ValidationResult)"><!-- --></A><H3> +validateForUpdate</H3> +<PRE> +void <B>validateForUpdate</B>(<A HREF="../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> validationResult)</PRE> +<DL> +<DD>Performs property validation of the MODIFIED object, appending any validation + failures to the provided validationResult object. This method is invoked by + DataContext before committing a MODIFIED object to the database. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="validateForDelete(org.objectstyle.cayenne.validation.ValidationResult)"><!-- --></A><H3> +validateForDelete</H3> +<PRE> +void <B>validateForDelete</B>(<A HREF="../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> validationResult)</PRE> +<DL> +<DD>Performs property validation of the DELETED object, appending any validation + failures to the provided validationResult object. This method is invoked by + DataContext before committing a DELETED object to the database. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</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/DataChannelListener.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.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/DataObject.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataObject.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | 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/DataObjectUtils.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObjectUtils.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObjectUtils.html new file mode 100644 index 0000000..1955454 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataObjectUtils.html @@ -0,0 +1,520 @@ +<!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> +DataObjectUtils (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.DataObjectUtils class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DataObjectUtils (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/DataObject.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/DataRow.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/DataObjectUtils.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataObjectUtils.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> +Class DataObjectUtils</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.DataObjectUtils</B> +</PRE> +<HR> +<DL> +<DT><PRE>public final class <B>DataObjectUtils</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +A collection of utility methods to work with DataObjects. + <p> + <i>DataObjects and Primary Keys: All methods that allow to extract primary key values + or use primary keys to find objects are provided for convenience. Still the author's + belief is that integer sequential primary keys are meaningless in the object model and + are pure database artifacts. Therefore relying heavily on direct access to PK provided + via this class (or other such Cayenne API) is not a clean design practice in many + cases, and sometimes may actually lead to security issues. </i> + </p> +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +<DT><B>Author:</B></DT> + <DD>Andrei 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>static java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#compoundPKForObject(org.objectstyle.cayenne.Persistent)">compoundPKForObject</A></B>(<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A> dataObject)</CODE> + +<BR> + Returns a primary key map for a DataObject.</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/DataObjectUtils.html#intPKForObject(org.objectstyle.cayenne.Persistent)">intPKForObject</A></B>(<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A> dataObject)</CODE> + +<BR> + Returns an int primary key value for a DataObject.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.Class, int)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.Class dataObjectClass, + int pk)</CODE> + +<BR> + Returns an object matching an int primary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.Class, java.util.Map)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.Class dataObjectClass, + java.util.Map pk)</CODE> + +<BR> + Returns an object matching a primary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.Class, java.lang.Object)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.Class dataObjectClass, + java.lang.Object pk)</CODE> + +<BR> + Returns an object matching an Object primary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> id)</CODE> + +<BR> + Returns an object matching ObjectId.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.String, int)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.String objEntityName, + int pk)</CODE> + +<BR> + Returns an object matching an int primary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.String, java.util.Map)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.String objEntityName, + java.util.Map pk)</CODE> + +<BR> + Returns an object matching a primary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.String, java.lang.Object)">objectForPK</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.String objEntityName, + java.lang.Object pk)</CODE> + +<BR> + Returns an object matching an Object primary key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForQuery(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.query.Query)">objectForQuery</A></B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + <A HREF="../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns a DataObject or a DataRow that is a result of a given query.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#pkForObject(org.objectstyle.cayenne.Persistent)">pkForObject</A></B>(<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A> dataObject)</CODE> + +<BR> + Returns a primary key value for a DataObject.</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> + +<!-- ============ 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="intPKForObject(org.objectstyle.cayenne.Persistent)"><!-- --></A><H3> +intPKForObject</H3> +<PRE> +public static int <B>intPKForObject</B>(<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A> dataObject)</PRE> +<DL> +<DD>Returns an int primary key value for a DataObject. Only works for single column + numeric primary keys. If a DataObjects is transient or has an ObjectId that can not + be converted to an int PK, an exception is thrown. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="pkForObject(org.objectstyle.cayenne.Persistent)"><!-- --></A><H3> +pkForObject</H3> +<PRE> +public static java.lang.Object <B>pkForObject</B>(<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A> dataObject)</PRE> +<DL> +<DD>Returns a primary key value for a DataObject. Only works for single column primary + keys. If a DataObjects is transient or has a compound ObjectId, an exception is + thrown. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="compoundPKForObject(org.objectstyle.cayenne.Persistent)"><!-- --></A><H3> +compoundPKForObject</H3> +<PRE> +public static java.util.Map <B>compoundPKForObject</B>(<A HREF="../../../org/objectstyle/cayenne/Persistent.html" title="interface in org.objectstyle.cayenne">Persistent</A> dataObject)</PRE> +<DL> +<DD>Returns a primary key map for a DataObject. This method is the most generic out of + all methods for primary key retrieval. It will work for all possible types of + primary keys. If a DataObjects is transient, an exception is thrown. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.Class, int)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.Class dataObjectClass, + int pk)</PRE> +<DL> +<DD>Returns an object matching an int primary key. If the object is mapped to use + non-integer PK or a compound PK, CayenneRuntimeException is thrown. + <p> + If this object is already cached in the ObjectStore, it is returned without a + query. Otherwise a query is built and executed against the database. + </p> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><CODE>objectForPK(ObjectContext, ObjectId)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.Class, java.lang.Object)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.Class dataObjectClass, + java.lang.Object pk)</PRE> +<DL> +<DD>Returns an object matching an Object primary key. If the object is mapped to use a + compound PK, CayenneRuntimeException is thrown. + <p> + If this object is already cached in the ObjectStore, it is returned without a + query. Otherwise a query is built and executed against the database. + </p> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><CODE>objectForPK(ObjectContext, ObjectId)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.Class, java.util.Map)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.Class dataObjectClass, + java.util.Map pk)</PRE> +<DL> +<DD>Returns an object matching a primary key. PK map parameter should use database PK + column names as keys. + <p> + If this object is already cached in the ObjectStore, it is returned without a + query. Otherwise a query is built and executed against the database. + </p> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><CODE>objectForPK(ObjectContext, ObjectId)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.String, int)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.String objEntityName, + int pk)</PRE> +<DL> +<DD>Returns an object matching an int primary key. If the object is mapped to use + non-integer PK or a compound PK, CayenneRuntimeException is thrown. + <p> + If this object is already cached in the ObjectStore, it is returned without a + query. Otherwise a query is built and executed against the database. + </p> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><CODE>objectForPK(ObjectContext, ObjectId)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.String, java.lang.Object)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.String objEntityName, + java.lang.Object pk)</PRE> +<DL> +<DD>Returns an object matching an Object primary key. If the object is mapped to use a + compound PK, CayenneRuntimeException is thrown. + <p> + If this object is already cached in the ObjectStore, it is returned without a + query. Otherwise a query is built and executed against the database. + </p> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><CODE>objectForPK(ObjectContext, ObjectId)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, java.lang.String, java.util.Map)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + java.lang.String objEntityName, + java.util.Map pk)</PRE> +<DL> +<DD>Returns an object matching a primary key. PK map parameter should use database PK + column names as keys. + <p> + If this object is already cached in the ObjectStore, it is returned without a + query. Otherwise a query is built and executed against the database. + </p> +<P> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../org/objectstyle/cayenne/DataObjectUtils.html#objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><CODE>objectForPK(ObjectContext, ObjectId)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="objectForPK(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.ObjectId)"><!-- --></A><H3> +objectForPK</H3> +<PRE> +public static <A HREF="../../../org/objectstyle/cayenne/DataObject.html" title="interface in org.objectstyle.cayenne">DataObject</A> <B>objectForPK</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> id)</PRE> +<DL> +<DD>Returns an object matching ObjectId. If this object is already cached in the + ObjectStore, it is returned without a query. Otherwise a query is built and + executed against the database. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>A DataObject that matched the id, null if no matching objects were found +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE> - if more than one object matched ObjectId.</DL> +</DD> +</DL> +<HR> + +<A NAME="objectForQuery(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +objectForQuery</H3> +<PRE> +public static java.lang.Object <B>objectForQuery</B>(<A HREF="../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> context, + <A HREF="../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns a DataObject or a DataRow that is a result of a given query. If query + returns more than one object, an exception is thrown. If query returns no objects, + null is returned. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</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/DataObject.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/DataRow.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/DataObjectUtils.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataObjectUtils.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/DataRow.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataRow.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataRow.html new file mode 100644 index 0000000..badcd24 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/DataRow.html @@ -0,0 +1,633 @@ +<!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> +DataRow (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.DataRow class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DataRow (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/DataObjectUtils.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/DeleteDenyException.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/DataRow.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataRow.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 DataRow</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.util.AbstractMap<K,V> + <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.util.HashMap + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.DataRow</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, java.util.Map</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>DataRow</B><DT>extends java.util.HashMap</DL> +</PRE> + +<P> +DataRow a map that holds values retrieved from the database for a given query row. + DataRows are used to cache raw database data and as a reference point for tracking + DataObject changes. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.objectstyle.cayenne.DataRow">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 long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#replacesVersion">replacesVersion</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#version">version</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/DataRow.html#DataRow(int)">DataRow</A></B>(int initialCapacity)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#DataRow(java.util.Map)">DataRow</A></B>(java.util.Map map)</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> <A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#applyDiff(org.objectstyle.cayenne.DataRow)">applyDiff</A></B>(<A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> diff)</CODE> + +<BR> + Builds a new DataRow, merging changes from <code>diff</code> parameter with data + contained in this DataRow.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#createDiff(org.objectstyle.cayenne.DataRow)">createDiff</A></B>(<A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> row)</CODE> + +<BR> + Creates a DataRow that contains only the keys that have values that differ between + this object and <code>row</code> parameter.</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/DataRow.html#createObjectId(java.lang.Class, org.objectstyle.cayenne.map.DbEntity)">createObjectId</A></B>(java.lang.Class objectClass, + <A HREF="../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. Now this method 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 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/DataRow.html#createObjectId(org.objectstyle.cayenne.map.ObjEntity)">createObjectId</A></B>(<A HREF="../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> entity)</CODE> + +<BR> + Creates an ObjectId from the values in the snapshot.</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/DataRow.html#createObjectId(java.lang.String, org.objectstyle.cayenne.map.DbEntity)">createObjectId</A></B>(java.lang.String entityName, + <A HREF="../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity)</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/DataRow.html#createObjectId(java.lang.String, org.objectstyle.cayenne.map.DbEntity, java.lang.String)">createObjectId</A></B>(java.lang.String entityName, + <A HREF="../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity, + java.lang.String namePrefix)</CODE> + +<BR> + Extracts PK columns prefixed with some path.</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/DataRow.html#createTargetObjectId(java.lang.Class, org.objectstyle.cayenne.map.DbRelationship)">createTargetObjectId</A></B>(java.lang.Class targetClass, + <A HREF="../../../org/objectstyle/cayenne/map/DbRelationship.html" title="class in org.objectstyle.cayenne.map">DbRelationship</A> relationship)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. Now this method 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 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/DataRow.html#createTargetObjectId(java.lang.String, org.objectstyle.cayenne.map.DbRelationship)">createTargetObjectId</A></B>(java.lang.String entityName, + <A HREF="../../../org/objectstyle/cayenne/map/DbRelationship.html" title="class in org.objectstyle.cayenne.map">DbRelationship</A> relationship)</CODE> + +<BR> + Returns an ObjectId of an object on the other side of the to-one relationship, for + this DataRow representing a source of relationship.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#getReplacesVersion()">getReplacesVersion</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/DataRow.html#getVersion()">getVersion</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/DataRow.html#setReplacesVersion(long)">setReplacesVersion</A></B>(long replacesVersion)</CODE> + +<BR> + Sets the version of DataRow replaced by this one in the store.</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/DataRow.html#toString()">toString</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.HashMap"><!-- --></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.util.HashMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.AbstractMap"><!-- --></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.util.AbstractMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, hashCode</CODE></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>finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface java.util.Map</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, hashCode</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="version"><!-- --></A><H3> +version</H3> +<PRE> +protected long <B>version</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="replacesVersion"><!-- --></A><H3> +replacesVersion</H3> +<PRE> +protected long <B>replacesVersion</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="DataRow(java.util.Map)"><!-- --></A><H3> +DataRow</H3> +<PRE> +public <B>DataRow</B>(java.util.Map map)</PRE> +<DL> +</DL> +<HR> + +<A NAME="DataRow(int)"><!-- --></A><H3> +DataRow</H3> +<PRE> +public <B>DataRow</B>(int initialCapacity)</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="getVersion()"><!-- --></A><H3> +getVersion</H3> +<PRE> +public long <B>getVersion</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getReplacesVersion()"><!-- --></A><H3> +getReplacesVersion</H3> +<PRE> +public long <B>getReplacesVersion</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setReplacesVersion(long)"><!-- --></A><H3> +setReplacesVersion</H3> +<PRE> +public void <B>setReplacesVersion</B>(long replacesVersion)</PRE> +<DL> +<DD>Sets the version of DataRow replaced by this one in the store. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="applyDiff(org.objectstyle.cayenne.DataRow)"><!-- --></A><H3> +applyDiff</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> <B>applyDiff</B>(<A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> diff)</PRE> +<DL> +<DD>Builds a new DataRow, merging changes from <code>diff</code> parameter with data + contained in this DataRow. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createDiff(org.objectstyle.cayenne.DataRow)"><!-- --></A><H3> +createDiff</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> <B>createDiff</B>(<A HREF="../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> row)</PRE> +<DL> +<DD>Creates a DataRow that contains only the keys that have values that differ between + this object and <code>row</code> parameter. Diff values are taken from the + <code>row</code> parameter. It is assumed that key sets are compatible in both + rows (e.g. they represent snapshots for the same entity). Returns null if no + differences are found. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createObjectId(org.objectstyle.cayenne.map.ObjEntity)"><!-- --></A><H3> +createObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createObjectId</B>(<A HREF="../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> entity)</PRE> +<DL> +<DD>Creates an ObjectId from the values in the snapshot. If needed attributes are + missing in a snapshot, CayenneRuntimeException is thrown. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createObjectId(java.lang.Class, org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +createObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createObjectId</B>(java.lang.Class objectClass, + <A HREF="../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. Now this method 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> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createTargetObjectId(java.lang.Class, org.objectstyle.cayenne.map.DbRelationship)"><!-- --></A><H3> +createTargetObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createTargetObjectId</B>(java.lang.Class targetClass, + <A HREF="../../../org/objectstyle/cayenne/map/DbRelationship.html" title="class in org.objectstyle.cayenne.map">DbRelationship</A> relationship)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2, as new portable ObjectIds can't store Java Class and store + entity name instead. Now this method 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> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createObjectId(java.lang.String, org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +createObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createObjectId</B>(java.lang.String entityName, + <A HREF="../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createTargetObjectId(java.lang.String, org.objectstyle.cayenne.map.DbRelationship)"><!-- --></A><H3> +createTargetObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createTargetObjectId</B>(java.lang.String entityName, + <A HREF="../../../org/objectstyle/cayenne/map/DbRelationship.html" title="class in org.objectstyle.cayenne.map">DbRelationship</A> relationship)</PRE> +<DL> +<DD>Returns an ObjectId of an object on the other side of the to-one relationship, for + this DataRow representing a source of relationship. Returns null if snapshot FK + columns indicate a null to-one relationship. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createObjectId(java.lang.String, org.objectstyle.cayenne.map.DbEntity, java.lang.String)"><!-- --></A><H3> +createObjectId</H3> +<PRE> +public <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>createObjectId</B>(java.lang.String entityName, + <A HREF="../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity, + java.lang.String namePrefix)</PRE> +<DL> +<DD>Extracts PK columns prefixed with some path. If namePrefix is null or empty, no + prefixing is done. + <p> + Prefixing is useful when extracting an ObjectId of a target row from a row obtained + via prefetching. namePrefix must omit the "db:" prefix and must end with ".", e.g. + "TO_ARTIST.PAINTING_ARRAY." + </p> +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</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.util.AbstractMap</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/DataObjectUtils.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/DeleteDenyException.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/DataRow.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataRow.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>
