http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/QueryResponse.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/QueryResponse.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/QueryResponse.html new file mode 100644 index 0000000..4b7e561 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/QueryResponse.html @@ -0,0 +1,402 @@ +<!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> +QueryResponse (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.QueryResponse interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="QueryResponse (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/PersistentObject.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/TempObjectId.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/QueryResponse.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryResponse.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 QueryResponse</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/objectstyle/cayenne/util/GenericResponse.html" title="class in org.objectstyle.cayenne.util">GenericResponse</A>, <A HREF="../../../org/objectstyle/cayenne/util/IncrementalListResponse.html" title="class in org.objectstyle.cayenne.util">IncrementalListResponse</A>, <A HREF="../../../org/objectstyle/cayenne/util/ListResponse.html" title="class in org.objectstyle.cayenne.util">ListResponse</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>QueryResponse</B></DL> +</PRE> + +<P> +Represents a result of query execution. It potentially contain a mix of update counts + and lists of selected values. Provides API somewhat similar to java.util.Iterator or + java.sql.ResultSet for scanning through the individual results. + <p> + An example of iterating through a response: + </p> + + <pre> + QueryResponse response = context.performGenericQuery(query); + for (response.reset(); response.next();) { + if (response.isList()) { + List list = response.currentList(); + // ... + } + else { + int[] updateCounts = reponse.currentUpdateCount(); + // ... + } + } + </pre> + + <p> + In case the structure of the result is known, and only a single list or an update count + is expected, there is a simpler API to access them: + </p> + + <pre> + QueryResponse response = context.performGenericQuery(query); + List list = response.firstList(); + int[] count = response.firstUpdateCount(); + </pre> +<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> java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/QueryResponse.html#currentList()">currentList</A></B>()</CODE> + +<BR> + Returns a List under the current iterator position.</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/QueryResponse.html#currentUpdateCount()">currentUpdateCount</A></B>()</CODE> + +<BR> + Returns an update count under the current iterator position.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/QueryResponse.html#firstList()">firstList</A></B>()</CODE> + +<BR> + A utility method for quickly retrieving the first list in the response.</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/QueryResponse.html#firstUpdateCount()">firstUpdateCount</A></B>()</CODE> + +<BR> + A utility method for quickly retrieving the first update count from the response.</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/QueryResponse.html#isList()">isList</A></B>()</CODE> + +<BR> + Returns whether current iteration result is a list or an update count.</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/QueryResponse.html#next()">next</A></B>()</CODE> + +<BR> + Rewinds response iterator to the next result, returning true if it is available.</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/QueryResponse.html#reset()">reset</A></B>()</CODE> + +<BR> + Restarts response iterator.</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/QueryResponse.html#size()">size</A></B>()</CODE> + +<BR> + Returns a number of results in the response.</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="size()"><!-- --></A><H3> +size</H3> +<PRE> +int <B>size</B>()</PRE> +<DL> +<DD>Returns a number of results in the response. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isList()"><!-- --></A><H3> +isList</H3> +<PRE> +boolean <B>isList</B>()</PRE> +<DL> +<DD>Returns whether current iteration result is a list or an update count. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="currentList()"><!-- --></A><H3> +currentList</H3> +<PRE> +java.util.List <B>currentList</B>()</PRE> +<DL> +<DD>Returns a List under the current iterator position. Use <A HREF="../../../org/objectstyle/cayenne/QueryResponse.html#isList()"><CODE>isList()</CODE></A> to check + the result type before calling this method. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="currentUpdateCount()"><!-- --></A><H3> +currentUpdateCount</H3> +<PRE> +int[] <B>currentUpdateCount</B>()</PRE> +<DL> +<DD>Returns an update count under the current iterator position. Returned value is an + int[] to accomodate batch queries. For a regular update result, the value will be + an int[1]. Use <A HREF="../../../org/objectstyle/cayenne/QueryResponse.html#isList()"><CODE>isList()</CODE></A> to check the result type before calling this + method. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="next()"><!-- --></A><H3> +next</H3> +<PRE> +boolean <B>next</B>()</PRE> +<DL> +<DD>Rewinds response iterator to the next result, returning true if it is available. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="reset()"><!-- --></A><H3> +reset</H3> +<PRE> +void <B>reset</B>()</PRE> +<DL> +<DD>Restarts response iterator. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="firstList()"><!-- --></A><H3> +firstList</H3> +<PRE> +java.util.List <B>firstList</B>()</PRE> +<DL> +<DD>A utility method for quickly retrieving the first list in the response. Note that + this method resets current iterator to an undefined state. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="firstUpdateCount()"><!-- --></A><H3> +firstUpdateCount</H3> +<PRE> +int[] <B>firstUpdateCount</B>()</PRE> +<DL> +<DD>A utility method for quickly retrieving the first update count from the response. + Note that this method resets current iterator to an undefined state. +<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/PersistentObject.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/TempObjectId.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/QueryResponse.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryResponse.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/TempObjectId.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/TempObjectId.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/TempObjectId.html new file mode 100644 index 0000000..e7c7332 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/TempObjectId.html @@ -0,0 +1,308 @@ +<!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> +TempObjectId (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.TempObjectId class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="TempObjectId (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/QueryResponse.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/ValueHolder.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/TempObjectId.html" target="_top"><B>FRAMES</B></A> + <A HREF="TempObjectId.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="#fields_inherited_from_class_org.objectstyle.cayenne.ObjectId">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: FIELD | <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 TempObjectId</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">org.objectstyle.cayenne.ObjectId</A> + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.TempObjectId</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<B>Deprecated.</B> <I>since 1.2 superclass can represent both permanent and temporary id.</I> +<P> +<DL> +<DT><PRE>public class <B>TempObjectId</B><DT>extends <A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></DL> +</PRE> + +<P> +An ObjectId for new objects that hasn't been committed to the external data store. On + commit, a TempObjectId is replaced with a permanent ObjectId tied to a primary key of + an object in the external data store. + <h3>Upgrade Note:</h3> + <p> + If you were referencing TempObjectId explicitly in your code (e.g. if(id instanceof + TempObjectId)...), you will need to modify the code and use "isTemporary()" superclass + method. + </p> +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrei Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.objectstyle.cayenne.TempObjectId">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> +</TABLE> + <A NAME="fields_inherited_from_class_org.objectstyle.cayenne.ObjectId"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Fields inherited from class org.objectstyle.cayenne.<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#entityName">entityName</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#key">key</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#objectIdKeys">objectIdKeys</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#replacementIdMap">replacementIdMap</A></CODE></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/TempObjectId.html#TempObjectId(java.lang.Class)">TempObjectId</A></B>(java.lang.Class objectClass)</CODE> + +<BR> + <B>Deprecated.</B> Creates a non-portable temporary ObjectId that should be replaced by a permanent id + once a corresponding object is committed.</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> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/TempObjectId.html#isTemporary()">isTemporary</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> Always returns <code>true</code>.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.objectstyle.cayenne.ObjectId"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class org.objectstyle.cayenne.<A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#createReplacementId()">createReplacementId</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getEntityName()">getEntityName</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getIdSnapshot()">getIdSnapshot</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getKey()">getKey</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getReplacementId()">getReplacementId</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getReplacementIdMap()">getReplacementIdMap</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#getValueForAttribute(java.lang.String)">getValueForAttribute</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#hashCode()">hashCode</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#isReplacementIdAttached()">isReplacementIdAttached</A>, <A HREF=" ../../../org/objectstyle/cayenne/ObjectId.html#setIdKeys(java.util.Map)">setIdKeys</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#setReplacementId(org.objectstyle.cayenne.ObjectId)">setReplacementId</A>, <A HREF="../../../org/objectstyle/cayenne/ObjectId.html#toString()">toString</A></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>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= 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="TempObjectId(java.lang.Class)"><!-- --></A><H3> +TempObjectId</H3> +<PRE> +public <B>TempObjectId</B>(java.lang.Class objectClass)</PRE> +<DL> +<DD><B>Deprecated.</B> <DD>Creates a non-portable temporary ObjectId that should be replaced by a permanent id + once a corresponding object is committed. +<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><B>Deprecated.</B> <DD>Always returns <code>true</code>. +<P> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/objectstyle/cayenne/ObjectId.html#isTemporary()">isTemporary</A></CODE> in class <CODE><A HREF="../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></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/QueryResponse.html" title="interface in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + <A HREF="../../../org/objectstyle/cayenne/ValueHolder.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/TempObjectId.html" target="_top"><B>FRAMES</B></A> + <A HREF="TempObjectId.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="#fields_inherited_from_class_org.objectstyle.cayenne.ObjectId">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: FIELD | <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/ValueHolder.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/ValueHolder.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/ValueHolder.html new file mode 100644 index 0000000..a01856c --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/ValueHolder.html @@ -0,0 +1,375 @@ +<!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> +ValueHolder (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.ValueHolder interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ValueHolder (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/TempObjectId.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/ValueHolder.html" target="_top"><B>FRAMES</B></A> + <A HREF="ValueHolder.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 ValueHolder</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/objectstyle/cayenne/util/IndexPropertyList.html" title="class in org.objectstyle.cayenne.util">IndexPropertyList</A>, <A HREF="../../../org/objectstyle/cayenne/util/PersistentObjectHolder.html" title="class in org.objectstyle.cayenne.util">PersistentObjectHolder</A>, <A HREF="../../../org/objectstyle/cayenne/util/PersistentObjectList.html" title="class in org.objectstyle.cayenne.util">PersistentObjectList</A>, <A HREF="../../../org/objectstyle/cayenne/access/ToManyList.html" title="class in org.objectstyle.cayenne.access">ToManyList</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>ValueHolder</B><DT>extends java.io.Serializable</DL> +</PRE> + +<P> +Provides a level of indirection for property value access, most often used for deferred + faulting of to-one relationships. A ValueHolder abstracts how a property value is + obtained (fetched from DB, etc.), thus simplifying design of an object that uses it. + <p> + Here is an example of a bean property implemented using ValueHolder: + </p> + + <pre> + protected ValueHolder someProperty; + + public SomeClass getSomeProperty() { + return (SomeClass) somePropertyHolder.getValue(SomeClass.class); + } + + public void setSomeProperty(SomeClass newValue) { + somePropertyHolder.setValue(SomeClass.class, newValue); + } + </pre> +<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> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/objectstyle/cayenne/ValueHolder.html#getValue()">getValue</A></B>()</CODE> + +<BR> + Returns an object stored by this ValueHolder.</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/ValueHolder.html#getValueDirectly()">getValueDirectly</A></B>()</CODE> + +<BR> + Retrieves ValueHolder value without triggering fault resolution.</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/ValueHolder.html#invalidate()">invalidate</A></B>()</CODE> + +<BR> + Turns a ValueHolder into a fault.</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/ValueHolder.html#isFault()">isFault</A></B>()</CODE> + +<BR> + Returns true if the internal value is not yet resolved.</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/ValueHolder.html#setValue(java.lang.Object)">setValue</A></B>(java.lang.Object value)</CODE> + +<BR> + Sets an object stored by this ValueHolder.</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/ValueHolder.html#setValueDirectly(java.lang.Object)">setValueDirectly</A></B>(java.lang.Object value)</CODE> + +<BR> + Sets ValueHolder vaue without triggering fault resolution.</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="getValue()"><!-- --></A><H3> +getValue</H3> +<PRE> +java.lang.Object <B>getValue</B>() + throws <A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE> +<DL> +<DD>Returns an object stored by this ValueHolder. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getValueDirectly()"><!-- --></A><H3> +getValueDirectly</H3> +<PRE> +java.lang.Object <B>getValueDirectly</B>() + throws <A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE> +<DL> +<DD>Retrieves ValueHolder value without triggering fault resolution. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="setValue(java.lang.Object)"><!-- --></A><H3> +setValue</H3> +<PRE> +java.lang.Object <B>setValue</B>(java.lang.Object value) + throws <A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE> +<DL> +<DD>Sets an object stored by this ValueHolder. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>value</CODE> - a new value of the ValueHolder. +<DT><B>Returns:</B><DD>a previous value saved in the ValueHolder. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="setValueDirectly(java.lang.Object)"><!-- --></A><H3> +setValueDirectly</H3> +<PRE> +java.lang.Object <B>setValueDirectly</B>(java.lang.Object value) + throws <A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE> +<DL> +<DD>Sets ValueHolder vaue without triggering fault resolution. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="isFault()"><!-- --></A><H3> +isFault</H3> +<PRE> +boolean <B>isFault</B>()</PRE> +<DL> +<DD>Returns true if the internal value is not yet resolved. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="invalidate()"><!-- --></A><H3> +invalidate</H3> +<PRE> +void <B>invalidate</B>()</PRE> +<DL> +<DD>Turns a ValueHolder into a fault. +<P> +<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/TempObjectId.html" title="class in org.objectstyle.cayenne"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/objectstyle/cayenne/ValueHolder.html" target="_top"><B>FRAMES</B></A> + <A HREF="ValueHolder.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/access/ClientServerChannel.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/ClientServerChannel.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/ClientServerChannel.html new file mode 100644 index 0000000..3b0ebdc --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/ClientServerChannel.html @@ -0,0 +1,502 @@ +<!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> +ClientServerChannel (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.ClientServerChannel class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ClientServerChannel (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"> + PREV CLASS + <A HREF="../../../../org/objectstyle/cayenne/access/ConnectionLogger.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/ClientServerChannel.html" target="_top"><B>FRAMES</B></A> + <A HREF="ClientServerChannel.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.access</FONT> +<BR> +Class ClientServerChannel</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.ClientServerChannel</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>ClientServerChannel</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></DL> +</PRE> + +<P> +A DataChannel adapter that connects client ObjectContext children to a server + ObjectContext. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +<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>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#lifecycleEventsEnabled">lifecycleEventsEnabled</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/access/ClientServerChannel.html#paginatedResults">paginatedResults</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/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#serverContext">serverContext</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="fields_inherited_from_class_org.objectstyle.cayenne.DataChannel"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Fields inherited from interface org.objectstyle.cayenne.<A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#FLUSH_CASCADE_SYNC">FLUSH_CASCADE_SYNC</A>, <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#FLUSH_NOCASCADE_SYNC">FLUSH_NOCASCADE_SYNC</A>, <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#GRAPH_CHANGED_SUBJECT">GRAPH_CHANGED_SUBJECT</A>, <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#GRAPH_FLUSHED_SUBJECT">GRAPH_FLUSHED_SUBJECT</A>, <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#GRAPH_ROLLEDBACK_SUBJECT">GRAPH_ROLLEDBACK_SUBJECT</A>, <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#ROLLBACK_CASCADE_SYNC">ROLLBACK_CASCADE_SYNC</A></CODE></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/access/ClientServerChannel.html#ClientServerChannel(org.objectstyle.cayenne.access.DataDomain)">ClientServerChannel</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#ClientServerChannel(org.objectstyle.cayenne.access.DataDomain, boolean)">ClientServerChannel</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain, + boolean lifecycleEventsEnabled)</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/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#getEntityResolver()">getEntityResolver</A></B>()</CODE> + +<BR> + Returns an EntityResolver instance that contains runtime mapping information.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#getEventManager()">getEventManager</A></B>()</CODE> + +<BR> + Returns an EventManager associated with this channel.</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/access/ClientServerChannel.html#isLifecycleEventsEnabled()">isLifecycleEventsEnabled</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/QueryResponse.html" title="interface in org.objectstyle.cayenne">QueryResponse</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#onQuery(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.query.Query)">onQuery</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> + Executes a query, using provided <em>context</em> to register persistent objects + if query returns any objects.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/graph/GraphDiff.html" title="interface in org.objectstyle.cayenne.graph">GraphDiff</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/ClientServerChannel.html#onSync(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.graph.GraphDiff, int)">onSync</A></B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> originatingContext, + <A HREF="../../../../org/objectstyle/cayenne/graph/GraphDiff.html" title="interface in org.objectstyle.cayenne.graph">GraphDiff</A> changes, + int syncType)</CODE> + +<BR> + Processes synchronization request from a child ObjectContext, returning a GraphDiff + that describes changes to objects made on the receiving end as a result of + syncronization.</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/access/ClientServerChannel.html#setLifecycleEventsEnabled(boolean)">setLifecycleEventsEnabled</A></B>(boolean lifecycleEventsEnabled)</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, 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="serverContext"><!-- --></A><H3> +serverContext</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A> <B>serverContext</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="lifecycleEventsEnabled"><!-- --></A><H3> +lifecycleEventsEnabled</H3> +<PRE> +protected boolean <B>lifecycleEventsEnabled</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="paginatedResults"><!-- --></A><H3> +paginatedResults</H3> +<PRE> +protected java.util.Map <B>paginatedResults</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="ClientServerChannel(org.objectstyle.cayenne.access.DataDomain)"><!-- --></A><H3> +ClientServerChannel</H3> +<PRE> +public <B>ClientServerChannel</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain)</PRE> +<DL> +</DL> +<HR> + +<A NAME="ClientServerChannel(org.objectstyle.cayenne.access.DataDomain, boolean)"><!-- --></A><H3> +ClientServerChannel</H3> +<PRE> +public <B>ClientServerChannel</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain, + boolean lifecycleEventsEnabled)</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="onQuery(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +onQuery</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/QueryResponse.html" title="interface in org.objectstyle.cayenne">QueryResponse</A> <B>onQuery</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><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#onQuery(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.query.Query)">DataChannel</A></CODE></B></DD> +<DD>Executes a query, using provided <em>context</em> to register persistent objects + if query returns any objects. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#onQuery(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.query.Query)">onQuery</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - an ObjectContext that originated the query, used to + register result objects. +<DT><B>Returns:</B><DD>a generic response object that encapsulates result of the execution.</DL> +</DD> +</DL> +<HR> + +<A NAME="getEntityResolver()"><!-- --></A><H3> +getEntityResolver</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A> <B>getEntityResolver</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#getEntityResolver()">DataChannel</A></CODE></B></DD> +<DD>Returns an EntityResolver instance that contains runtime mapping information. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#getEntityResolver()">getEntityResolver</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getEventManager()"><!-- --></A><H3> +getEventManager</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> <B>getEventManager</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#getEventManager()">DataChannel</A></CODE></B></DD> +<DD>Returns an EventManager associated with this channel. Channel may return null if + EventManager is not available for any reason. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#getEventManager()">getEventManager</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isLifecycleEventsEnabled()"><!-- --></A><H3> +isLifecycleEventsEnabled</H3> +<PRE> +public boolean <B>isLifecycleEventsEnabled</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setLifecycleEventsEnabled(boolean)"><!-- --></A><H3> +setLifecycleEventsEnabled</H3> +<PRE> +public void <B>setLifecycleEventsEnabled</B>(boolean lifecycleEventsEnabled)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="onSync(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.graph.GraphDiff, int)"><!-- --></A><H3> +onSync</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/graph/GraphDiff.html" title="interface in org.objectstyle.cayenne.graph">GraphDiff</A> <B>onSync</B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectContext.html" title="interface in org.objectstyle.cayenne">ObjectContext</A> originatingContext, + <A HREF="../../../../org/objectstyle/cayenne/graph/GraphDiff.html" title="interface in org.objectstyle.cayenne.graph">GraphDiff</A> changes, + int syncType)</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#onSync(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.graph.GraphDiff, int)">DataChannel</A></CODE></B></DD> +<DD>Processes synchronization request from a child ObjectContext, returning a GraphDiff + that describes changes to objects made on the receiving end as a result of + syncronization. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#onSync(org.objectstyle.cayenne.ObjectContext, org.objectstyle.cayenne.graph.GraphDiff, int)">onSync</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/DataChannel.html" title="interface in org.objectstyle.cayenne">DataChannel</A></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>originatingContext</CODE> - an ObjectContext that initiated the sync. Can be null.<DD><CODE>changes</CODE> - diff from the context that initiated the sync.<DD><CODE>syncType</CODE> - One of <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#FLUSH_NOCASCADE_SYNC"><CODE>DataChannel.FLUSH_NOCASCADE_SYNC</CODE></A>, <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#FLUSH_CASCADE_SYNC"><CODE>DataChannel.FLUSH_CASCADE_SYNC</CODE></A>, + <A HREF="../../../../org/objectstyle/cayenne/DataChannel.html#ROLLBACK_CASCADE_SYNC"><CODE>DataChannel.ROLLBACK_CASCADE_SYNC</CODE></A>.</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"> + PREV CLASS + <A HREF="../../../../org/objectstyle/cayenne/access/ConnectionLogger.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/ClientServerChannel.html" target="_top"><B>FRAMES</B></A> + <A HREF="ClientServerChannel.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/access/ConnectionLogger.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/ConnectionLogger.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/ConnectionLogger.html new file mode 100644 index 0000000..ad276ad --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/ConnectionLogger.html @@ -0,0 +1,341 @@ +<!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> +ConnectionLogger (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.ConnectionLogger class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ConnectionLogger (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/access/ClientServerChannel.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/ConnectionLogger.html" target="_top"><B>FRAMES</B></A> + <A HREF="ConnectionLogger.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <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.access</FONT> +<BR> +Class ConnectionLogger</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.ConnectionLogger</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn">ConnectionEventLoggingDelegate</A></DD> +</DL> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/access/util/ConnectionEventLogger.html" title="class in org.objectstyle.cayenne.access.util">ConnectionEventLogger</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>ConnectionLogger</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn">ConnectionEventLoggingDelegate</A></DL> +</PRE> + +<P> +Adapts <A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html" title="class in org.objectstyle.cayenne.access"><CODE>QueryLogger</CODE></A> to be used as a + <A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn"><CODE>ConnectionEventLoggingDelegate</CODE></A> with Cayenne + connection pools. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +</DL> +<HR> + +<P> + +<!-- ======== 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/access/ConnectionLogger.html#ConnectionLogger()">ConnectionLogger</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/access/ConnectionLogger.html#logConnect(java.lang.String, java.lang.String, java.lang.String)">logConnect</A></B>(java.lang.String url, + java.lang.String userName, + java.lang.String password)</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/access/ConnectionLogger.html#logConnectFailure(java.lang.Throwable)">logConnectFailure</A></B>(java.lang.Throwable th)</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/access/ConnectionLogger.html#logConnectSuccess()">logConnectSuccess</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/access/ConnectionLogger.html#logPoolCreated(org.objectstyle.cayenne.conn.DataSourceInfo)">logPoolCreated</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> info)</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, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= 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="ConnectionLogger()"><!-- --></A><H3> +ConnectionLogger</H3> +<PRE> +public <B>ConnectionLogger</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="logConnect(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +logConnect</H3> +<PRE> +public void <B>logConnect</B>(java.lang.String url, + java.lang.String userName, + java.lang.String password)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html#logConnect(java.lang.String, java.lang.String, java.lang.String)">logConnect</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn">ConnectionEventLoggingDelegate</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnectFailure(java.lang.Throwable)"><!-- --></A><H3> +logConnectFailure</H3> +<PRE> +public void <B>logConnectFailure</B>(java.lang.Throwable th)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html#logConnectFailure(java.lang.Throwable)">logConnectFailure</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn">ConnectionEventLoggingDelegate</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnectSuccess()"><!-- --></A><H3> +logConnectSuccess</H3> +<PRE> +public void <B>logConnectSuccess</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html#logConnectSuccess()">logConnectSuccess</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn">ConnectionEventLoggingDelegate</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logPoolCreated(org.objectstyle.cayenne.conn.DataSourceInfo)"><!-- --></A><H3> +logPoolCreated</H3> +<PRE> +public void <B>logPoolCreated</B>(<A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> info)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html#logPoolCreated(org.objectstyle.cayenne.conn.DataSourceInfo)">logPoolCreated</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/conn/ConnectionEventLoggingDelegate.html" title="interface in org.objectstyle.cayenne.conn">ConnectionEventLoggingDelegate</A></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/access/ClientServerChannel.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/ConnectionLogger.html" target="_top"><B>FRAMES</B></A> + <A HREF="ConnectionLogger.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <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>
