http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryLogger.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryLogger.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryLogger.html new file mode 100644 index 0000000..47a4f80 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryLogger.html @@ -0,0 +1,1209 @@ +<!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> +QueryLogger (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.QueryLogger class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="QueryLogger (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/QueryEngine.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryResult.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/QueryLogger.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryLogger.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 QueryLogger</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.QueryLogger</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>QueryLogger</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +QueryLogger is intended to log special events that happen whenever Cayenne interacts + with a database. This includes execution of generated SQL statements, result counts, + connection events, etc. Normally QueryLogger methods are not invoked directly by the + user. Rather it is a single logging point used by the framework. + <p> + Internally QueryLogger uses Log4J. See a chapter on logging in Cayenne User Guide on + how to setup Log4J. + </p> +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +</DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static org.apache.log4j.Level</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#DEFAULT_LOG_LEVEL">DEFAULT_LOG_LEVEL</A></B></CODE> + +<BR> + <B>Deprecated.</B> <I>unused since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#TRIM_VALUES_THRESHOLD">TRIM_VALUES_THRESHOLD</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/QueryLogger.html#QueryLogger()">QueryLogger</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>protected static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#appendFormattedByte(java.lang.StringBuffer, byte)">appendFormattedByte</A></B>(java.lang.StringBuffer buffer, + byte byteValue)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2 use a namesake method from IDUtil.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static org.apache.log4j.Level</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#getLoggingLevel()">getLoggingLevel</A></B>()</CODE> + +<BR> + Returns current logging level.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#isLoggable()">isLoggable</A></B>()</CODE> + +<BR> + Returns true if current thread default log level is high enough for QueryLogger to + generate output.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#isLoggable(org.apache.log4j.Level)">isLoggable</A></B>(org.apache.log4j.Level logLevel)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#log(java.lang.String)">log</A></B>(java.lang.String message)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logBeginTransaction(org.apache.log4j.Level, java.lang.String)">logBeginTransaction</A></B>(org.apache.log4j.Level logLevel, + java.lang.String transactionLabel)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logBeginTransaction(java.lang.String)">logBeginTransaction</A></B>(java.lang.String transactionLabel)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logCommitTransaction(org.apache.log4j.Level, java.lang.String)">logCommitTransaction</A></B>(org.apache.log4j.Level logLevel, + java.lang.String transactionLabel)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logCommitTransaction(java.lang.String)">logCommitTransaction</A></B>(java.lang.String transactionLabel)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logConnect(org.apache.log4j.Level, java.lang.String)">logConnect</A></B>(org.apache.log4j.Level logLevel, + java.lang.String dataSource)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logConnect(org.apache.log4j.Level, java.lang.String, java.lang.String, java.lang.String)">logConnect</A></B>(org.apache.log4j.Level logLevel, + java.lang.String url, + java.lang.String userName, + java.lang.String password)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logConnect(java.lang.String)">logConnect</A></B>(java.lang.String dataSource)</CODE> + +<BR> + Logs database connection event using container data source.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.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>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logConnectFailure(org.apache.log4j.Level, java.lang.Throwable)">logConnectFailure</A></B>(org.apache.log4j.Level logLevel, + java.lang.Throwable th)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.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>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.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>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logConnectSuccess(org.apache.log4j.Level)">logConnectSuccess</A></B>(org.apache.log4j.Level logLevel)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.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> dsi)</CODE> + +<BR> + Logs database connection event.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logPoolCreated(org.apache.log4j.Level, org.objectstyle.cayenne.conn.DataSourceInfo)">logPoolCreated</A></B>(org.apache.log4j.Level logLevel, + <A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> dsi)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQuery(org.apache.log4j.Level, java.lang.String, java.util.List)">logQuery</A></B>(org.apache.log4j.Level logLevel, + java.lang.String queryStr, + java.util.List params)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQuery(org.apache.log4j.Level, java.lang.String, java.util.List, long)">logQuery</A></B>(org.apache.log4j.Level logLevel, + java.lang.String queryStr, + java.util.List params, + long time)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQuery(java.lang.String, java.util.List)">logQuery</A></B>(java.lang.String queryStr, + java.util.List params)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQuery(java.lang.String, java.util.List, long)">logQuery</A></B>(java.lang.String queryStr, + java.util.List params, + long time)</CODE> + +<BR> + Log query content using Log4J Category with "INFO" priority.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQueryError(org.apache.log4j.Level, java.lang.Throwable)">logQueryError</A></B>(org.apache.log4j.Level logLevel, + java.lang.Throwable th)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQueryError(java.lang.Throwable)">logQueryError</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>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQueryParameters(org.apache.log4j.Level, java.lang.String, java.util.List)">logQueryParameters</A></B>(org.apache.log4j.Level logLevel, + java.lang.String label, + java.util.List parameters)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQueryParameters(java.lang.String, java.util.List)">logQueryParameters</A></B>(java.lang.String label, + java.util.List parameters)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQueryStart(int)">logQueryStart</A></B>(int count)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logQueryStart(org.apache.log4j.Level, int)">logQueryStart</A></B>(org.apache.log4j.Level logLevel, + int count)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logRollbackTransaction(org.apache.log4j.Level, java.lang.String)">logRollbackTransaction</A></B>(org.apache.log4j.Level logLevel, + java.lang.String transactionLabel)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logRollbackTransaction(java.lang.String)">logRollbackTransaction</A></B>(java.lang.String transactionLabel)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logSelectCount(int)">logSelectCount</A></B>(int count)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logSelectCount(int, long)">logSelectCount</A></B>(int count, + long time)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logSelectCount(org.apache.log4j.Level, int)">logSelectCount</A></B>(org.apache.log4j.Level logLevel, + int count)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logSelectCount(org.apache.log4j.Level, int, long)">logSelectCount</A></B>(org.apache.log4j.Level logLevel, + int count, + long time)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logUpdateCount(int)">logUpdateCount</A></B>(int count)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#logUpdateCount(org.apache.log4j.Level, int)">logUpdateCount</A></B>(org.apache.log4j.Level logLevel, + int count)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#setLoggingLevel(org.apache.log4j.Level)">setLoggingLevel</A></B>(org.apache.log4j.Level level)</CODE> + +<BR> + Sets logging level for the current thread.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryLogger.html#sqlLiteralForObject(java.lang.StringBuffer, java.lang.Object)">sqlLiteralForObject</A></B>(java.lang.StringBuffer buf, + java.lang.Object anObject)</CODE> + +<BR> + Utility method that appends SQL literal for the specified object to the buffer.</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="DEFAULT_LOG_LEVEL"><!-- --></A><H3> +DEFAULT_LOG_LEVEL</H3> +<PRE> +public static final org.apache.log4j.Level <B>DEFAULT_LOG_LEVEL</B></PRE> +<DL> +<DD><B>Deprecated.</B> <I>unused since 1.2</I><DL> +</DL> +</DL> +<HR> + +<A NAME="TRIM_VALUES_THRESHOLD"><!-- --></A><H3> +TRIM_VALUES_THRESHOLD</H3> +<PRE> +public static final int <B>TRIM_VALUES_THRESHOLD</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.QueryLogger.TRIM_VALUES_THRESHOLD">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="QueryLogger()"><!-- --></A><H3> +QueryLogger</H3> +<PRE> +public <B>QueryLogger</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="sqlLiteralForObject(java.lang.StringBuffer, java.lang.Object)"><!-- --></A><H3> +sqlLiteralForObject</H3> +<PRE> +public static void <B>sqlLiteralForObject</B>(java.lang.StringBuffer buf, + java.lang.Object anObject)</PRE> +<DL> +<DD>Utility method that appends SQL literal for the specified object to the buffer. + <p> + Note: this method is not intended to build SQL queries, rather this is used in + logging routines only. In particular it will trim large values to avoid flooding + the logs. + </p> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>buf</CODE> - buffer to append value<DD><CODE>anObject</CODE> - object to be transformed to SQL literal.</DL> +</DD> +</DL> +<HR> + +<A NAME="appendFormattedByte(java.lang.StringBuffer, byte)"><!-- --></A><H3> +appendFormattedByte</H3> +<PRE> +protected static void <B>appendFormattedByte</B>(java.lang.StringBuffer buffer, + byte byteValue)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2 use a namesake method from IDUtil.</I> +<P> +<DD>Prints a byte value to a StringBuffer as a double digit hex value. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getLoggingLevel()"><!-- --></A><H3> +getLoggingLevel</H3> +<PRE> +public static org.apache.log4j.Level <B>getLoggingLevel</B>()</PRE> +<DL> +<DD>Returns current logging level. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setLoggingLevel(org.apache.log4j.Level)"><!-- --></A><H3> +setLoggingLevel</H3> +<PRE> +public static void <B>setLoggingLevel</B>(org.apache.log4j.Level level)</PRE> +<DL> +<DD>Sets logging level for the current thread. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="log(java.lang.String)"><!-- --></A><H3> +log</H3> +<PRE> +public static void <B>log</B>(java.lang.String message)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2 logs an arbitrary message using logging level setup for QueryLogger.</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnect(java.lang.String)"><!-- --></A><H3> +logConnect</H3> +<PRE> +public static void <B>logConnect</B>(java.lang.String dataSource)</PRE> +<DL> +<DD>Logs database connection event using container data source. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnect(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +logConnect</H3> +<PRE> +public static void <B>logConnect</B>(java.lang.String url, + java.lang.String userName, + java.lang.String password)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logPoolCreated(org.objectstyle.cayenne.conn.DataSourceInfo)"><!-- --></A><H3> +logPoolCreated</H3> +<PRE> +public static void <B>logPoolCreated</B>(<A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> dsi)</PRE> +<DL> +<DD>Logs database connection event. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnectSuccess()"><!-- --></A><H3> +logConnectSuccess</H3> +<PRE> +public static void <B>logConnectSuccess</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnectFailure(java.lang.Throwable)"><!-- --></A><H3> +logConnectFailure</H3> +<PRE> +public static void <B>logConnectFailure</B>(java.lang.Throwable th)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQuery(java.lang.String, java.util.List)"><!-- --></A><H3> +logQuery</H3> +<PRE> +public static void <B>logQuery</B>(java.lang.String queryStr, + java.util.List params)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQuery(java.lang.String, java.util.List, long)"><!-- --></A><H3> +logQuery</H3> +<PRE> +public static void <B>logQuery</B>(java.lang.String queryStr, + java.util.List params, + long time)</PRE> +<DL> +<DD>Log query content using Log4J Category with "INFO" priority. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>queryStr</CODE> - Query SQL string<DD><CODE>params</CODE> - optional list of query parameters that are used when executing query + in prepared statement.<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQueryParameters(java.lang.String, java.util.List)"><!-- --></A><H3> +logQueryParameters</H3> +<PRE> +public static void <B>logQueryParameters</B>(java.lang.String label, + java.util.List parameters)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logSelectCount(int)"><!-- --></A><H3> +logSelectCount</H3> +<PRE> +public static void <B>logSelectCount</B>(int count)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logSelectCount(int, long)"><!-- --></A><H3> +logSelectCount</H3> +<PRE> +public static void <B>logSelectCount</B>(int count, + long time)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logUpdateCount(int)"><!-- --></A><H3> +logUpdateCount</H3> +<PRE> +public static void <B>logUpdateCount</B>(int count)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logBeginTransaction(java.lang.String)"><!-- --></A><H3> +logBeginTransaction</H3> +<PRE> +public static void <B>logBeginTransaction</B>(java.lang.String transactionLabel)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logCommitTransaction(java.lang.String)"><!-- --></A><H3> +logCommitTransaction</H3> +<PRE> +public static void <B>logCommitTransaction</B>(java.lang.String transactionLabel)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logRollbackTransaction(java.lang.String)"><!-- --></A><H3> +logRollbackTransaction</H3> +<PRE> +public static void <B>logRollbackTransaction</B>(java.lang.String transactionLabel)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQueryError(java.lang.Throwable)"><!-- --></A><H3> +logQueryError</H3> +<PRE> +public static void <B>logQueryError</B>(java.lang.Throwable th)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQueryStart(int)"><!-- --></A><H3> +logQueryStart</H3> +<PRE> +public static void <B>logQueryStart</B>(int count)</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isLoggable()"><!-- --></A><H3> +isLoggable</H3> +<PRE> +public static boolean <B>isLoggable</B>()</PRE> +<DL> +<DD>Returns true if current thread default log level is high enough for QueryLogger to + generate output. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnect(org.apache.log4j.Level, java.lang.String)"><!-- --></A><H3> +logConnect</H3> +<PRE> +public static void <B>logConnect</B>(org.apache.log4j.Level logLevel, + java.lang.String dataSource)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD>Logs database connection event using container data source. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnect(org.apache.log4j.Level, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +logConnect</H3> +<PRE> +public static void <B>logConnect</B>(org.apache.log4j.Level logLevel, + java.lang.String url, + java.lang.String userName, + java.lang.String password)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logPoolCreated(org.apache.log4j.Level, org.objectstyle.cayenne.conn.DataSourceInfo)"><!-- --></A><H3> +logPoolCreated</H3> +<PRE> +public static void <B>logPoolCreated</B>(org.apache.log4j.Level logLevel, + <A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> dsi)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD>Logs database connection event. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnectSuccess(org.apache.log4j.Level)"><!-- --></A><H3> +logConnectSuccess</H3> +<PRE> +public static void <B>logConnectSuccess</B>(org.apache.log4j.Level logLevel)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logConnectFailure(org.apache.log4j.Level, java.lang.Throwable)"><!-- --></A><H3> +logConnectFailure</H3> +<PRE> +public static void <B>logConnectFailure</B>(org.apache.log4j.Level logLevel, + java.lang.Throwable th)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQuery(org.apache.log4j.Level, java.lang.String, java.util.List)"><!-- --></A><H3> +logQuery</H3> +<PRE> +public static void <B>logQuery</B>(org.apache.log4j.Level logLevel, + java.lang.String queryStr, + java.util.List params)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQuery(org.apache.log4j.Level, java.lang.String, java.util.List, long)"><!-- --></A><H3> +logQuery</H3> +<PRE> +public static void <B>logQuery</B>(org.apache.log4j.Level logLevel, + java.lang.String queryStr, + java.util.List params, + long time)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQueryParameters(org.apache.log4j.Level, java.lang.String, java.util.List)"><!-- --></A><H3> +logQueryParameters</H3> +<PRE> +public static void <B>logQueryParameters</B>(org.apache.log4j.Level logLevel, + java.lang.String label, + java.util.List parameters)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logSelectCount(org.apache.log4j.Level, int)"><!-- --></A><H3> +logSelectCount</H3> +<PRE> +public static void <B>logSelectCount</B>(org.apache.log4j.Level logLevel, + int count)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logSelectCount(org.apache.log4j.Level, int, long)"><!-- --></A><H3> +logSelectCount</H3> +<PRE> +public static void <B>logSelectCount</B>(org.apache.log4j.Level logLevel, + int count, + long time)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logUpdateCount(org.apache.log4j.Level, int)"><!-- --></A><H3> +logUpdateCount</H3> +<PRE> +public static void <B>logUpdateCount</B>(org.apache.log4j.Level logLevel, + int count)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logBeginTransaction(org.apache.log4j.Level, java.lang.String)"><!-- --></A><H3> +logBeginTransaction</H3> +<PRE> +public static void <B>logBeginTransaction</B>(org.apache.log4j.Level logLevel, + java.lang.String transactionLabel)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logCommitTransaction(org.apache.log4j.Level, java.lang.String)"><!-- --></A><H3> +logCommitTransaction</H3> +<PRE> +public static void <B>logCommitTransaction</B>(org.apache.log4j.Level logLevel, + java.lang.String transactionLabel)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logRollbackTransaction(org.apache.log4j.Level, java.lang.String)"><!-- --></A><H3> +logRollbackTransaction</H3> +<PRE> +public static void <B>logRollbackTransaction</B>(org.apache.log4j.Level logLevel, + java.lang.String transactionLabel)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQueryError(org.apache.log4j.Level, java.lang.Throwable)"><!-- --></A><H3> +logQueryError</H3> +<PRE> +public static void <B>logQueryError</B>(org.apache.log4j.Level logLevel, + java.lang.Throwable th)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="logQueryStart(org.apache.log4j.Level, int)"><!-- --></A><H3> +logQueryStart</H3> +<PRE> +public static void <B>logQueryStart</B>(org.apache.log4j.Level logLevel, + int count)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isLoggable(org.apache.log4j.Level)"><!-- --></A><H3> +isLoggable</H3> +<PRE> +public static boolean <B>isLoggable</B>(org.apache.log4j.Level logLevel)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2</I> +<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/QueryEngine.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryResult.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/QueryLogger.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryLogger.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/QueryResult.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryResult.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryResult.html new file mode 100644 index 0000000..adf1691 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/QueryResult.html @@ -0,0 +1,664 @@ +<!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> +QueryResult (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.QueryResult class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="QueryResult (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/QueryLogger.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryTranslator.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/QueryResult.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryResult.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 QueryResult</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">org.objectstyle.cayenne.access.util.DefaultOperationObserver</A> + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.QueryResult</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html" title="interface in org.objectstyle.cayenne.access">OperationHints</A>, <A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>QueryResult</B><DT>extends <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></DL> +</PRE> + +<P> +QueryResult encapsulates a result of execution of zero or more queries using + QueryEngine. QueryResult supports queries with multiple mixed selects and updates, such + as ProcedureQueries. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrus Adamchik</DD> +</DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryResult.html#queries">queries</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="fields_inherited_from_class_org.objectstyle.cayenne.access.util.DefaultOperationObserver"><!-- --></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.access.util.<A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#DEFAULT_LOG_LEVEL">DEFAULT_LOG_LEVEL</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#globalExceptions">globalExceptions</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#queryExceptions">queryExceptions</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/QueryResult.html#QueryResult()">QueryResult</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/QueryResult.html#clear()">clear</A></B>()</CODE> + +<BR> + Clears any previously collected information.</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/access/QueryResult.html#getFirstRows(org.objectstyle.cayenne.query.Query)">getFirstRows</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns the first results for the query.</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/access/QueryResult.html#getFirstUpdateCount(org.objectstyle.cayenne.query.Query)">getFirstUpdateCount</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns the first update count for the query.</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/access/QueryResult.html#getFirstUpdateCounts(org.objectstyle.cayenne.query.Query)">getFirstUpdateCounts</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns the first update count.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Iterator</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/QueryResult.html#getQueries()">getQueries</A></B>()</CODE> + +<BR> + Returns an iterator over all executed queries in the order they were executed.</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/access/QueryResult.html#getResults(org.objectstyle.cayenne.query.Query)">getResults</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns a list of all results of a given query.</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/access/QueryResult.html#getRows(org.objectstyle.cayenne.query.Query)">getRows</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns a List that itself contains Lists of data rows for each ResultSet returned + by the query.</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/access/QueryResult.html#getUpdates(org.objectstyle.cayenne.query.Query)">getUpdates</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</CODE> + +<BR> + Returns a List that contains java.lang.Integer objects for each one of the update + counts returned by the query.</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/QueryResult.html#isIteratedResult()">isIteratedResult</A></B>()</CODE> + +<BR> + Always returns <code>false</code>, iterated results are not supported.</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/QueryResult.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/QueryResult.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/QueryResult.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/QueryResult.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> + Closes ResultIterator without reading its data.</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/QueryResult.html#nextGlobalException(java.lang.Exception)">nextGlobalException</A></B>(java.lang.Exception ex)</CODE> + +<BR> + Overrides superclass implementation to rethrow an exception immediately.</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/QueryResult.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> + Overrides superclass implementation to rethrow an exception immediately.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.objectstyle.cayenne.access.util.DefaultOperationObserver"><!-- --></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.access.util.<A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#getGlobalExceptions()">getGlobalExceptions</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#getLoggingLevel()">getLoggingLevel</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#getQueryExceptions()">getQueryExceptions</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#hasExceptions()">hasExceptions</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextGeneratedDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)">nextGeneratedDataRows</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#printExceptions(java.io.PrintWriter)">printExceptions</A>, <A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#setLoggingLevel (org.apache.log4j.Level)">setLoggingLevel</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, 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="queries"><!-- --></A><H3> +queries</H3> +<PRE> +protected java.util.Map <B>queries</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="QueryResult()"><!-- --></A><H3> +QueryResult</H3> +<PRE> +public <B>QueryResult</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="clear()"><!-- --></A><H3> +clear</H3> +<PRE> +public void <B>clear</B>()</PRE> +<DL> +<DD>Clears any previously collected information. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getQueries()"><!-- --></A><H3> +getQueries</H3> +<PRE> +public java.util.Iterator <B>getQueries</B>()</PRE> +<DL> +<DD>Returns an iterator over all executed queries in the order they were executed. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getResults(org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +getResults</H3> +<PRE> +public java.util.List <B>getResults</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns a list of all results of a given query. This is potentially a mix of + java.lang.Integer values for update operations and java.util.List for select + operations. Results are returned in the order they were obtained. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getFirstUpdateCount(org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +getFirstUpdateCount</H3> +<PRE> +public int <B>getFirstUpdateCount</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns the first update count for the query. This is a shortcut for + <code>(Integer)getUpdates(query).get(0)<code>, kind of like Google's "I'm feeling lucky". + Returns -1 if no update count is found for the query. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getFirstUpdateCounts(org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +getFirstUpdateCounts</H3> +<PRE> +public int[] <B>getFirstUpdateCounts</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns the first update count. Returns int[0] if there was no update results for + the query. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getFirstRows(org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +getFirstRows</H3> +<PRE> +public java.util.List <B>getFirstRows</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns the first results for the query. This is a shortcut for + <code>(List)getRows(query).get(0)<code>, kind of like Google's "I'm feeling lucky". +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getRows(org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +getRows</H3> +<PRE> +public java.util.List <B>getRows</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns a List that itself contains Lists of data rows for each ResultSet returned + by the query. ResultSets are returned in the oder they were obtained. Any updates + that were performed are not included. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getUpdates(org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +getUpdates</H3> +<PRE> +public java.util.List <B>getUpdates</B>(<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> query)</PRE> +<DL> +<DD>Returns a List that contains java.lang.Integer objects for each one of the update + counts returned by the query. Update counts are returned in the order they were + obtained. Batched and regular updates are combined together. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextQueryException(org.objectstyle.cayenne.query.Query, java.lang.Exception)"><!-- --></A><H3> +nextQueryException</H3> +<PRE> +public 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>Overrides superclass implementation to rethrow an exception immediately. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextQueryException(org.objectstyle.cayenne.query.Query, java.lang.Exception)">nextQueryException</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextQueryException(org.objectstyle.cayenne.query.Query, java.lang.Exception)">nextQueryException</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextGlobalException(java.lang.Exception)"><!-- --></A><H3> +nextGlobalException</H3> +<PRE> +public void <B>nextGlobalException</B>(java.lang.Exception ex)</PRE> +<DL> +<DD>Overrides superclass implementation to rethrow an exception immediately. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextGlobalException(java.lang.Exception)">nextGlobalException</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextGlobalException(java.lang.Exception)">nextGlobalException</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isIteratedResult()"><!-- --></A><H3> +isIteratedResult</H3> +<PRE> +public boolean <B>isIteratedResult</B>()</PRE> +<DL> +<DD>Always returns <code>false</code>, iterated results are not supported. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html#isIteratedResult()">isIteratedResult</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationHints.html" title="interface in org.objectstyle.cayenne.access">OperationHints</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#isIteratedResult()">isIteratedResult</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextBatchCount(org.objectstyle.cayenne.query.Query, int[])"><!-- --></A><H3> +nextBatchCount</H3> +<PRE> +public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextBatchCount(org.objectstyle.cayenne.query.Query, int[])">OperationObserver</A></CODE></B></DD> +<DD>Callback method invoked after a batch update is executed. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextBatchCount(org.objectstyle.cayenne.query.Query, int[])">nextBatchCount</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextBatchCount(org.objectstyle.cayenne.query.Query, int[])">nextBatchCount</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextCount(org.objectstyle.cayenne.query.Query, int)"><!-- --></A><H3> +nextCount</H3> +<PRE> +public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextCount(org.objectstyle.cayenne.query.Query, int)">OperationObserver</A></CODE></B></DD> +<DD>Callback method invoked after an updating query is executed. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextCount(org.objectstyle.cayenne.query.Query, int)">nextCount</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextCount(org.objectstyle.cayenne.query.Query, int)">nextCount</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="nextDataRows(org.objectstyle.cayenne.query.Query, java.util.List)"><!-- --></A><H3> +nextDataRows</H3> +<PRE> +public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, java.util.List)">OperationObserver</A></CODE></B></DD> +<DD>Callback method invoked for each processed ResultSet. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, java.util.List)">nextDataRows</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, java.util.List)">nextDataRows</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</A></CODE></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> +public 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><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)">DefaultOperationObserver</A></CODE></B></DD> +<DD>Closes ResultIterator without reading its data. If you implement a custom subclass, + only call super if closing the iterator is what you need. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)">nextDataRows</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/access/OperationObserver.html" title="interface in org.objectstyle.cayenne.access">OperationObserver</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html#nextDataRows(org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.access.ResultIterator)">nextDataRows</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/access/util/DefaultOperationObserver.html" title="class in org.objectstyle.cayenne.access.util">DefaultOperationObserver</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/QueryLogger.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/QueryTranslator.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/QueryResult.html" target="_top"><B>FRAMES</B></A> + <A HREF="QueryResult.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>
