| <!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:51 EDT 2006 --> |
| <TITLE> |
| BatchQuery (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.query.BatchQuery class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="BatchQuery (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/query/AbstractQuery.html" title="class in org.objectstyle.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html" title="class in org.objectstyle.cayenne.query"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/query/BatchQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BatchQuery.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.query</FONT> |
| <BR> |
| Class BatchQuery</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.query.BatchQuery</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html" title="class in org.objectstyle.cayenne.query">DeleteBatchQuery</A>, <A HREF="../../../../org/objectstyle/cayenne/query/InsertBatchQuery.html" title="class in org.objectstyle.cayenne.query">InsertBatchQuery</A>, <A HREF="../../../../org/objectstyle/cayenne/query/UpdateBatchQuery.html" title="class in org.objectstyle.cayenne.query">UpdateBatchQuery</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>BatchQuery</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></DL> |
| </PRE> |
| |
| <P> |
| BatchQuery and its descendants allow to group similar data for the batch database |
| modifications, including inserts, updates and deletes. Single BatchQuery corresponds to |
| a parameterized PreparedStatement and a matrix of values. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andriy Shapochka, Andrus Adamchik</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.objectstyle.cayenne.query.BatchQuery">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 int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#batchIndex">batchIndex</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/query/BatchQuery.html#dbEntity">dbEntity</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/query/BatchQuery.html#name">name</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/query/BatchQuery.html#BatchQuery(org.objectstyle.cayenne.map.DbEntity)">BatchQuery</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEntity)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/query/SQLAction.html" title="interface in org.objectstyle.cayenne.query">SQLAction</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#createSQLAction(org.objectstyle.cayenne.query.SQLActionVisitor)">createSQLAction</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/SQLActionVisitor.html" title="interface in org.objectstyle.cayenne.query">SQLActionVisitor</A> visitor)</CODE> |
| |
| <BR> |
| Calls "batchAction" on the visitor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getDbAttributes()">getDbAttributes</A></B>()</CODE> |
| |
| <BR> |
| Returns a list of DbAttributes describing batch parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <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/query/BatchQuery.html#getDbEntity()">getDbEntity</A></B>()</CODE> |
| |
| <BR> |
| Returns a DbEntity associated with this batch.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/query/QueryMetadata.html" title="interface in org.objectstyle.cayenne.query">QueryMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getMetaData(org.objectstyle.cayenne.map.EntityResolver)">getMetaData</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A> resolver)</CODE> |
| |
| <BR> |
| Returns default select parameters.</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/query/BatchQuery.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Returns a symbolic name of the query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getObject(int)">getObject</A></B>(int valueIndex)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Since 1.2 renamed to "getValue()"</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getObjectId()">getObjectId</A></B>()</CODE> |
| |
| <BR> |
| Returns an ObjectId associated with the current batch iteration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getRoot()">getRoot</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 as the corresponding interface method is also deprecated.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getValue(int)">getValue</A></B>(int valueIndex)</CODE> |
| |
| <BR> |
| Returns a value at a given index for the current batch iteration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getValue(java.util.Map, org.objectstyle.cayenne.map.DbAttribute)">getValue</A></B>(java.util.Map valueMap, |
| <A HREF="../../../../org/objectstyle/cayenne/map/DbAttribute.html" title="class in org.objectstyle.cayenne.map">DbAttribute</A> attribute)</CODE> |
| |
| <BR> |
| A helper method used by subclasses to resolve deferred values on demand.</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/query/BatchQuery.html#getValuesForUpdateParameters(boolean)">getValuesForUpdateParameters</A></B>(boolean includeNullValues)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Since 1.2 use BatchQueryBuilder.getParameterValues(), as this allows |
| better control over which attributes are logged.</I></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/query/BatchQuery.html#isEmpty()">isEmpty</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this batch query has no parameter rows.</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/query/BatchQuery.html#isUsingOptimisticLocking()">isUsingOptimisticLocking</A></B>()</CODE> |
| |
| <BR> |
| Returns true if the batch query uses optimistic locking.</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/query/BatchQuery.html#next()">next</A></B>()</CODE> |
| |
| <BR> |
| Repositions batch to the next object, so that subsequent calls to getObject(int) |
| would return the values of the next batch object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#reset()">reset</A></B>()</CODE> |
| |
| <BR> |
| Rewinds batch to the first parameter row.</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/query/BatchQuery.html#route(org.objectstyle.cayenne.query.QueryRouter, org.objectstyle.cayenne.map.EntityResolver, org.objectstyle.cayenne.query.Query)">route</A></B>(<A HREF="../../../../org/objectstyle/cayenne/query/QueryRouter.html" title="interface in org.objectstyle.cayenne.query">QueryRouter</A> router, |
| <A HREF="../../../../org/objectstyle/cayenne/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A> resolver, |
| <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> substitutedQuery)</CODE> |
| |
| <BR> |
| A callback method invoked by Cayenne during the routing phase of the query |
| execution.</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/query/BatchQuery.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Sets a symbolic name of the query.</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/query/BatchQuery.html#setRoot(java.lang.Object)">setRoot</A></B>(java.lang.Object root)</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>abstract int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#size()">size</A></B>()</CODE> |
| |
| <BR> |
| Returns the number of parameter rows in a batch.</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="batchIndex"><!-- --></A><H3> |
| batchIndex</H3> |
| <PRE> |
| protected int <B>batchIndex</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dbEntity"><!-- --></A><H3> |
| dbEntity</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> <B>dbEntity</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="name"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| protected java.lang.String <B>name</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="BatchQuery(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> |
| BatchQuery</H3> |
| <PRE> |
| public <B>BatchQuery</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEntity)</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="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public java.lang.String <B>getName</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#getName()">Query</A></CODE></B></DD> |
| <DD>Returns a symbolic name of the query. The name may be used as a key to find queries |
| stored in the DataMap. Some query implementors reuse the name as a QueryMetadata |
| cache key. Generally the name can be null. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| public void <B>setName</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#setName(java.lang.String)">Query</A></CODE></B></DD> |
| <DD>Sets a symbolic name of the query. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#setName(java.lang.String)">setName</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMetaData(org.objectstyle.cayenne.map.EntityResolver)"><!-- --></A><H3> |
| getMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/query/QueryMetadata.html" title="interface in org.objectstyle.cayenne.query">QueryMetadata</A> <B>getMetaData</B>(<A HREF="../../../../org/objectstyle/cayenne/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A> resolver)</PRE> |
| <DL> |
| <DD>Returns default select parameters. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#getMetaData(org.objectstyle.cayenne.map.EntityResolver)">getMetaData</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRoot()"><!-- --></A><H3> |
| getRoot</H3> |
| <PRE> |
| public java.lang.Object <B>getRoot</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 as the corresponding interface method is also deprecated.</I> |
| <P> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#getRoot()">Query</A></CODE></B></DD> |
| <DD>Returns the root object of the query. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#getRoot()">getRoot</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRoot(java.lang.Object)"><!-- --></A><H3> |
| setRoot</H3> |
| <PRE> |
| public void <B>setRoot</B>(java.lang.Object root)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2</I> |
| <P> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#setRoot(java.lang.Object)">Query</A></CODE></B></DD> |
| <DD>Sets the root of the query. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#setRoot(java.lang.Object)">setRoot</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="route(org.objectstyle.cayenne.query.QueryRouter, org.objectstyle.cayenne.map.EntityResolver, org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> |
| route</H3> |
| <PRE> |
| public void <B>route</B>(<A HREF="../../../../org/objectstyle/cayenne/query/QueryRouter.html" title="interface in org.objectstyle.cayenne.query">QueryRouter</A> router, |
| <A HREF="../../../../org/objectstyle/cayenne/map/EntityResolver.html" title="class in org.objectstyle.cayenne.map">EntityResolver</A> resolver, |
| <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> substitutedQuery)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#route(org.objectstyle.cayenne.query.QueryRouter, org.objectstyle.cayenne.map.EntityResolver, org.objectstyle.cayenne.query.Query)">Query</A></CODE></B></DD> |
| <DD>A callback method invoked by Cayenne during the routing phase of the query |
| execution. Mapping of DataNodes is provided by QueryRouter. Query should use a |
| <A HREF="../../../../org/objectstyle/cayenne/query/QueryRouter.html#route(org.objectstyle.cayenne.access.QueryEngine, org.objectstyle.cayenne.query.Query, org.objectstyle.cayenne.query.Query)"><CODE>QueryRouter.route(QueryEngine, Query, Query)</CODE></A> callback method to route |
| itself. Query can create one or more substitute queries or even provide its own |
| QueryEngine to execute itself. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#route(org.objectstyle.cayenne.query.QueryRouter, org.objectstyle.cayenne.map.EntityResolver, org.objectstyle.cayenne.query.Query)">route</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createSQLAction(org.objectstyle.cayenne.query.SQLActionVisitor)"><!-- --></A><H3> |
| createSQLAction</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/query/SQLAction.html" title="interface in org.objectstyle.cayenne.query">SQLAction</A> <B>createSQLAction</B>(<A HREF="../../../../org/objectstyle/cayenne/query/SQLActionVisitor.html" title="interface in org.objectstyle.cayenne.query">SQLActionVisitor</A> visitor)</PRE> |
| <DL> |
| <DD>Calls "batchAction" on the visitor. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html#createSQLAction(org.objectstyle.cayenne.query.SQLActionVisitor)">createSQLAction</A></CODE> in interface <CODE><A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isUsingOptimisticLocking()"><!-- --></A><H3> |
| isUsingOptimisticLocking</H3> |
| <PRE> |
| public boolean <B>isUsingOptimisticLocking</B>()</PRE> |
| <DL> |
| <DD>Returns true if the batch query uses optimistic locking. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDbEntity()"><!-- --></A><H3> |
| getDbEntity</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> <B>getDbEntity</B>()</PRE> |
| <DL> |
| <DD>Returns a DbEntity associated with this batch. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValuesForUpdateParameters(boolean)"><!-- --></A><H3> |
| getValuesForUpdateParameters</H3> |
| <PRE> |
| public java.util.List <B>getValuesForUpdateParameters</B>(boolean includeNullValues)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Since 1.2 use BatchQueryBuilder.getParameterValues(), as this allows |
| better control over which attributes are logged.</I> |
| <P> |
| <DD>Returns a List of values for the current batch iteration, in the order they are |
| bound to the query. Used mainly for logging. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>includeNullValues</CODE> - A <code>true</code> value indicates that the returned |
| list should include <code>null</code> values and <code>false</code> |
| indicates they should not be included.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isEmpty()"><!-- --></A><H3> |
| isEmpty</H3> |
| <PRE> |
| public boolean <B>isEmpty</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if this batch query has no parameter rows. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDbAttributes()"><!-- --></A><H3> |
| getDbAttributes</H3> |
| <PRE> |
| public abstract java.util.List <B>getDbAttributes</B>()</PRE> |
| <DL> |
| <DD>Returns a list of DbAttributes describing batch parameters. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="reset()"><!-- --></A><H3> |
| reset</H3> |
| <PRE> |
| public void <B>reset</B>()</PRE> |
| <DL> |
| <DD>Rewinds batch to the first parameter row. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="next()"><!-- --></A><H3> |
| next</H3> |
| <PRE> |
| public boolean <B>next</B>()</PRE> |
| <DL> |
| <DD>Repositions batch to the next object, so that subsequent calls to getObject(int) |
| would return the values of the next batch object. Returns <code>true</code> if |
| batch has more objects to iterate over, <code>false</code> otherwise. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObject(int)"><!-- --></A><H3> |
| getObject</H3> |
| <PRE> |
| public java.lang.Object <B>getObject</B>(int valueIndex)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Since 1.2 renamed to "getValue()"</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValue(int)"><!-- --></A><H3> |
| getValue</H3> |
| <PRE> |
| public abstract java.lang.Object <B>getValue</B>(int valueIndex)</PRE> |
| <DL> |
| <DD>Returns a value at a given index for the current batch iteration. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="size()"><!-- --></A><H3> |
| size</H3> |
| <PRE> |
| public abstract int <B>size</B>()</PRE> |
| <DL> |
| <DD>Returns the number of parameter rows in a batch. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValue(java.util.Map, org.objectstyle.cayenne.map.DbAttribute)"><!-- --></A><H3> |
| getValue</H3> |
| <PRE> |
| protected java.lang.Object <B>getValue</B>(java.util.Map valueMap, |
| <A HREF="../../../../org/objectstyle/cayenne/map/DbAttribute.html" title="class in org.objectstyle.cayenne.map">DbAttribute</A> attribute)</PRE> |
| <DL> |
| <DD>A helper method used by subclasses to resolve deferred values on demand. This is |
| useful when a certain value comes from a generated key of another master object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObjectId()"><!-- --></A><H3> |
| getObjectId</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> <B>getObjectId</B>()</PRE> |
| <DL> |
| <DD>Returns an ObjectId associated with the current batch iteration. Used internally by |
| Cayenne to match current iteration with a specific object and assign it generated |
| keys. |
| <p> |
| Default implementation simply returns null. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/query/AbstractQuery.html" title="class in org.objectstyle.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html" title="class in org.objectstyle.cayenne.query"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/query/BatchQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BatchQuery.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> |
