http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OperationObserver.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OperationObserver.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OperationObserver.html new file mode 100644 index 0000000..5db1b20 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OperationObserver.html @@ -0,0 +1,400 @@ +<!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> +OperationObserver (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.OperationObserver interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="OperationObserver (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/OperationHints.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.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/OperationObserver.html" target="_top"><B>FRAMES</B></A> + <A HREF="OperationObserver.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.access</FONT> +<BR> +Interface OperationObserver</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html" title="interface in org.objectstyle.cayenne.access">OperationHints</A></DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/access/util/ContextCommitObserver.html" title="class in org.objectstyle.cayenne.access.util">ContextCommitObserver</A>, <A HREF="../../../../org/objectstyle/cayenne/access/DataDomainLegacyQueryAction.html" title="class in org.objectstyle.cayenne.access">DataDomainLegacyQueryAction</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/IteratedSelectObserver.html" title="class in org.objectstyle.cayenne.access.util">IteratedSelectObserver</A>, <A HREF="../../../../org/objectstyle/cayenne/access/QueryResult.html" title="class in org.objectstyle.cayenne.access">QueryResult</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/SelectObserver.html" title="class in org.objectstyle.cayenne.access.util">SelectObserver </A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>OperationObserver</B><DT>extends <A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html" title="interface in org.objectstyle.cayenne.access">OperationHints</A></DL> +</PRE> + +<P> +Defines a set of callback methods that allow QueryEngine to pass back query results and + notify caller about exceptions. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrei Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface in org.objectstyle.cayenne.access"><CODE>QueryEngine</CODE></A></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> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextBatchCount(org.objectstyle.cayenne.query.Query, int[])">nextBatchCount</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + int[] resultCount)</CODE> + +<BR> + Callback method invoked after a batch update is executed.</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/OperationObserver.html#nextCount(org.objectstyle.cayenne.query.Query, int)">nextCount</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + int resultCount)</CODE> + +<BR> + Callback method invoked after an updating query is executed.</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/OperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, java.util.List)">nextDataRows</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + java.util.List dataRows)</CODE> + +<BR> + Callback method invoked for each processed ResultSet.</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/OperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)">nextDataRows</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> q, + <A HREF="../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A> it)</CODE> + +<BR> + Callback method invoked for each opened ResultIterator.</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/OperationObserver.html#nextGeneratedDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)">nextGeneratedDataRows</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + <A HREF="../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A> keysIterator)</CODE> + +<BR> + Callback method invoked after each batch of generated values is read durring an + update.</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/OperationObserver.html#nextGlobalException(java.lang.Exception)">nextGlobalException</A></B>(java.lang.Exception ex)</CODE> + +<BR> + Callback method invoked on exceptions that are not tied to a specific query + execution, such as JDBC connection exceptions, etc.</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/OperationObserver.html#nextQueryException(org.objectstyle.cayenne.query.Query, java.lang.Exception)">nextQueryException</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + java.lang.Exception ex)</CODE> + +<BR> + Callback method invoked on exceptions that happen during an execution of a specific + query.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.objectstyle.cayenne.access.OperationHints"><!-- --></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.access.<A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html" title="interface in org.objectstyle.cayenne.access">OperationHints</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html#getLoggingLevel()">getLoggingLevel</A>, <A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html#isIteratedResult()">isIteratedResult</A></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="nextCount(org.objectstyle.cayenne.query.Query, int)"><!-- --></A><H3> +nextCount</H3> +<PRE> +void <B>nextCount</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + int resultCount)</PRE> +<DL> +<DD>Callback method invoked after an updating query is executed. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextBatchCount(org.objectstyle.cayenne.query.Query, int[])"><!-- --></A><H3> +nextBatchCount</H3> +<PRE> +void <B>nextBatchCount</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + int[] resultCount)</PRE> +<DL> +<DD>Callback method invoked after a batch update is executed. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextDataRows(org.objectstyle.cayenne.query.Query, java.util.List)"><!-- --></A><H3> +nextDataRows</H3> +<PRE> +void <B>nextDataRows</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + java.util.List dataRows)</PRE> +<DL> +<DD>Callback method invoked for each processed ResultSet. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)"><!-- --></A><H3> +nextDataRows</H3> +<PRE> +void <B>nextDataRows</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> q, + <A HREF="../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A> it)</PRE> +<DL> +<DD>Callback method invoked for each opened ResultIterator. If this observer requested + results to be returned as a ResultIterator, this method is invoked instead of + "nextDataRows(Query,List)". OperationObserver is responsible for closing the + ResultIterators passed via this method. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextGeneratedDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)"><!-- --></A><H3> +nextGeneratedDataRows</H3> +<PRE> +void <B>nextGeneratedDataRows</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + <A HREF="../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A> keysIterator)</PRE> +<DL> +<DD>Callback method invoked after each batch of generated values is read durring an + update. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextQueryException(org.objectstyle.cayenne.query.Query, java.lang.Exception)"><!-- --></A><H3> +nextQueryException</H3> +<PRE> +void <B>nextQueryException</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query, + java.lang.Exception ex)</PRE> +<DL> +<DD>Callback method invoked on exceptions that happen during an execution of a specific + query. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextGlobalException(java.lang.Exception)"><!-- --></A><H3> +nextGlobalException</H3> +<PRE> +void <B>nextGlobalException</B>(java.lang.Exception ex)</PRE> +<DL> +<DD>Callback method invoked on exceptions that are not tied to a specific query + execution, such as JDBC connection exceptions, etc. +<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/access/OperationHints.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.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/OperationObserver.html" target="_top"><B>FRAMES</B></A> + <A HREF="OperationObserver.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/OptimisticLockException.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OptimisticLockException.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OptimisticLockException.html new file mode 100644 index 0000000..2523cda --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/OptimisticLockException.html @@ -0,0 +1,426 @@ +<!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> +OptimisticLockException (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.OptimisticLockException class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="OptimisticLockException (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/OperationObserver.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface 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/OptimisticLockException.html" target="_top"><B>FRAMES</B></A> + <A HREF="OptimisticLockException.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 OptimisticLockException</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">org.objectstyle.cayenne.CayenneRuntimeException</A> + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.OptimisticLockException</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>OptimisticLockException</B><DT>extends <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></DL> +</PRE> + +<P> +An exception thrown on optimistic lock failure. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +<DT><B>Author:</B></DT> + <DD>Andrei Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.objectstyle.cayenne.access.OptimisticLockException">Serialized Form</A></DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.html#qualifierSnapshot">qualifierSnapshot</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.html#querySQL">querySQL</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/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.html#rootEntity">rootEntity</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/access/OptimisticLockException.html#OptimisticLockException(org.objectstyle.cayenne.map.DbEntity, java.lang.String, java.util.Map)">OptimisticLockException</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> rootEntity, + java.lang.String querySQL, + java.util.Map qualifierSnapshot)</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> java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.html#getFreshSnapshot(org.objectstyle.cayenne.access.QueryEngine)">getFreshSnapshot</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface in org.objectstyle.cayenne.access">QueryEngine</A> engine)</CODE> + +<BR> + Retrieves fresh snapshot for the failed row.</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/access/OptimisticLockException.html#getMessage()">getMessage</A></B>()</CODE> + +<BR> + Returns descriptive message for this exception.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.html#getQualifierSnapshot()">getQualifierSnapshot</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/OptimisticLockException.html#getQuerySQL()">getQuerySQL</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.objectstyle.cayenne.CayenneRuntimeException"><!-- --></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/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html#getUnlabeledMessage()">getUnlabeledMessage</A></CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="querySQL"><!-- --></A><H3> +querySQL</H3> +<PRE> +protected java.lang.String <B>querySQL</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="rootEntity"><!-- --></A><H3> +rootEntity</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> <B>rootEntity</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="qualifierSnapshot"><!-- --></A><H3> +qualifierSnapshot</H3> +<PRE> +protected java.util.Map <B>qualifierSnapshot</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="OptimisticLockException(org.objectstyle.cayenne.map.DbEntity, java.lang.String, java.util.Map)"><!-- --></A><H3> +OptimisticLockException</H3> +<PRE> +public <B>OptimisticLockException</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> rootEntity, + java.lang.String querySQL, + java.util.Map qualifierSnapshot)</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="getQualifierSnapshot()"><!-- --></A><H3> +getQualifierSnapshot</H3> +<PRE> +public java.util.Map <B>getQualifierSnapshot</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getQuerySQL()"><!-- --></A><H3> +getQuerySQL</H3> +<PRE> +public java.lang.String <B>getQuerySQL</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getFreshSnapshot(org.objectstyle.cayenne.access.QueryEngine)"><!-- --></A><H3> +getFreshSnapshot</H3> +<PRE> +public java.util.Map <B>getFreshSnapshot</B>(<A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface in org.objectstyle.cayenne.access">QueryEngine</A> engine)</PRE> +<DL> +<DD>Retrieves fresh snapshot for the failed row. Null row indicates that it was + deleted. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getMessage()"><!-- --></A><H3> +getMessage</H3> +<PRE> +public java.lang.String <B>getMessage</B>()</PRE> +<DL> +<DD>Returns descriptive message for this exception. +<P> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html#getMessage()">getMessage</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</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/OperationObserver.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface 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/OptimisticLockException.html" target="_top"><B>FRAMES</B></A> + <A HREF="OptimisticLockException.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/QueryEngine.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryEngine.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryEngine.html new file mode 100644 index 0000000..0e7bc32 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryEngine.html @@ -0,0 +1,330 @@ +<!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> +QueryEngine (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.QueryEngine interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="QueryEngine (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/OptimisticLockException.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.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/QueryEngine.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryEngine.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.access</FONT> +<BR> +Interface QueryEngine</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>, <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A>, <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>, <A HREF="../../../../org/objectstyle/cayenne/dba/oracle/OracleDataNode.html" title="class in org.objectstyle.cayenne.dba.oracle">OracleDataNode</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>QueryEngine</B></DL> +</PRE> + +<P> +Defines methods used to run Cayenne queries. + <p> + <i>For more information see <a href="../../../../../../userguide/index.html" + target="_top">Cayenne User Guide. </a> </i> + </p> +<P> + +<P> +<DL> +<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> java.util.Collection</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html#getDataMaps()">getDataMaps</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2. Use 'getEntityResolver().getDataMaps()' instead.</I></TD> +</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/QueryEngine.html#getEntityResolver()">getEntityResolver</A></B>()</CODE> + +<BR> + Returns a resolver for this query engine that is capable of resolving between + classes, entity names, and obj/db entities</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html#lookupDataNode(org.objectstyle.cayenne.map.DataMap)">lookupDataNode</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2 not a part of the interface. Only DataDomain has meaningful + implementation.</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/access/QueryEngine.html#performQueries(java.util.Collection, org.objectstyle.cayenne.access.OperationObserver)">performQueries</A></B>(java.util.Collection queries, + <A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A> resultConsumer)</CODE> + +<BR> + Executes a list of queries wrapping them in its own transaction.</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/QueryEngine.html#performQueries(java.util.Collection, org.objectstyle.cayenne.access.OperationObserver, org.objectstyle.cayenne.access.Transaction)">performQueries</A></B>(java.util.Collection queries, + <A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A> resultConsumer, + <A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A> transaction)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2 as thread-bound transactions are used.</I></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="performQueries(java.util.Collection, org.objectstyle.cayenne.access.OperationObserver, org.objectstyle.cayenne.access.Transaction)"><!-- --></A><H3> +performQueries</H3> +<PRE> +void <B>performQueries</B>(java.util.Collection queries, + <A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A> resultConsumer, + <A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A> transaction)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2 as thread-bound transactions are used.</I> +<P> +<DD>Executes queries in the transactional context provided by the caller. It is + caller's responsibility to commit or rollback the Transaction and close any + connections that were added to it. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="performQueries(java.util.Collection, org.objectstyle.cayenne.access.OperationObserver)"><!-- --></A><H3> +performQueries</H3> +<PRE> +void <B>performQueries</B>(java.util.Collection queries, + <A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A> resultConsumer)</PRE> +<DL> +<DD>Executes a list of queries wrapping them in its own transaction. Results of + execution are passed to <A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access"><CODE>OperationObserver</CODE></A>object via its callback methods. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1 The signiture has changed from List to Collection.</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="lookupDataNode(org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +lookupDataNode</H3> +<PRE> +<A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> <B>lookupDataNode</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2 not a part of the interface. Only DataDomain has meaningful + implementation.</I> +<P> +<DD>Returns a DataNode that should handle queries for all DataMap components. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getEntityResolver()"><!-- --></A><H3> +getEntityResolver</H3> +<PRE> +<A HREF="../../../../org/objectstyle/cayenne/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A> <B>getEntityResolver</B>()</PRE> +<DL> +<DD>Returns a resolver for this query engine that is capable of resolving between + classes, entity names, and obj/db entities +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getDataMaps()"><!-- --></A><H3> +getDataMaps</H3> +<PRE> +java.util.Collection <B>getDataMaps</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2. Use 'getEntityResolver().getDataMaps()' instead.</I> +<P> +<DD>Returns a collection of DataMaps associated with this QueryEngine. +<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/access/OptimisticLockException.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.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/QueryEngine.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryEngine.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>
