| <!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> |
| DeleteBatchQuery (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.query.DeleteBatchQuery class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="DeleteBatchQuery (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/BatchQuery.html" title="class in org.objectstyle.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/query/DeleteQuery.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/DeleteBatchQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DeleteBatchQuery.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 DeleteBatchQuery</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">org.objectstyle.cayenne.query.BatchQuery</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.query.DeleteBatchQuery</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> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>DeleteBatchQuery</B><DT>extends <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></DL> |
| </PRE> |
| |
| <P> |
| Batched delete query. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andriy Shapochka</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.objectstyle.cayenne.query.DeleteBatchQuery">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#dbAttributes">dbAttributes</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#qualifierSnapshots">qualifierSnapshots</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#usingOptimisticLocking">usingOptimisticLocking</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.objectstyle.cayenne.query.BatchQuery"><!-- --></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.query.<A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#batchIndex">batchIndex</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#dbEntity">dbEntity</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#name">name</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/query/DeleteBatchQuery.html#DeleteBatchQuery(org.objectstyle.cayenne.map.DbEntity, int)">DeleteBatchQuery</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEntity, |
| int batchCapacity)</CODE> |
| |
| <BR> |
| Creates new DeleteBatchQuery.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#DeleteBatchQuery(org.objectstyle.cayenne.map.DbEntity, java.util.List, java.util.Collection, int)">DeleteBatchQuery</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEntity, |
| java.util.List qualifierAttributes, |
| java.util.Collection nullQualifierNames, |
| int batchCapacity)</CODE> |
| |
| <BR> |
| Creates new DeleteBatchQuery.</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/query/DeleteBatchQuery.html#add(java.util.Map)">add</A></B>(java.util.Map dataObjectId)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#getCurrentQualifier()">getCurrentQualifier</A></B>()</CODE> |
| |
| <BR> |
| Returns a snapshot of the current qualifier values.</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/DeleteBatchQuery.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> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#getQualifierAttributes()">getQualifierAttributes</A></B>()</CODE> |
| |
| <BR> |
| </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/DeleteBatchQuery.html#getValue(int)">getValue</A></B>(int dbAttributeIndex)</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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#isNull(org.objectstyle.cayenne.map.DbAttribute)">isNull</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbAttribute.html" title="class in org.objectstyle.cayenne.map">DbAttribute</A> attribute)</CODE> |
| |
| <BR> |
| Returns true if a given attribute always has a null value in the batch.</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/DeleteBatchQuery.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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/query/DeleteBatchQuery.html#setUsingOptimisticLocking(boolean)">setUsingOptimisticLocking</A></B>(boolean usingOptimisticLocking)</CODE> |
| |
| <BR> |
| </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/query/DeleteBatchQuery.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_org.objectstyle.cayenne.query.BatchQuery"><!-- --></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.query.<A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#createSQLAction(org.objectstyle.cayenne.query.SQLActionVisitor)">createSQLAction</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getDbEntity()">getDbEntity</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getMetaData(org.objectstyle.cayenne.map.EntityResolver)">getMetaData</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getName()">getName</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getObject(int)">getObject</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getObjectId()">getObjectId</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getRoot()">getRoot</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getValue(java.util.Map, org.objectstyle.cayenne.map.DbAttribute)">getValue</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getValuesForUpdateParameters(boolean)">getValuesForUpdateParameters</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#isEmpty()">isEmpty</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#next()">next</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#reset()">reset</A>, <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>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#setRoot(java.lang.Object)">setRoot</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="qualifierSnapshots"><!-- --></A><H3> |
| qualifierSnapshots</H3> |
| <PRE> |
| protected java.util.List <B>qualifierSnapshots</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dbAttributes"><!-- --></A><H3> |
| dbAttributes</H3> |
| <PRE> |
| protected java.util.List <B>dbAttributes</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="usingOptimisticLocking"><!-- --></A><H3> |
| usingOptimisticLocking</H3> |
| <PRE> |
| protected boolean <B>usingOptimisticLocking</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="DeleteBatchQuery(org.objectstyle.cayenne.map.DbEntity, int)"><!-- --></A><H3> |
| DeleteBatchQuery</H3> |
| <PRE> |
| public <B>DeleteBatchQuery</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEntity, |
| int batchCapacity)</PRE> |
| <DL> |
| <DD>Creates new DeleteBatchQuery. Used by |
| ContextCommit.categorizeFlattenedDeletesAndCreateBatches for deleting flattenned |
| relationships. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>dbEntity</CODE> - Table or view to delete.<DD><CODE>batchCapacity</CODE> - Estimated size of the batch.</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DeleteBatchQuery(org.objectstyle.cayenne.map.DbEntity, java.util.List, java.util.Collection, int)"><!-- --></A><H3> |
| DeleteBatchQuery</H3> |
| <PRE> |
| public <B>DeleteBatchQuery</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEntity, |
| java.util.List qualifierAttributes, |
| java.util.Collection nullQualifierNames, |
| int batchCapacity)</PRE> |
| <DL> |
| <DD>Creates new DeleteBatchQuery. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>dbEntity</CODE> - Table or view to delete.<DD><CODE>qualifierAttributes</CODE> - DbAttributes used in the WHERE clause.<DD><CODE>nullQualifierNames</CODE> - DbAttribute names in the WHERE clause that have null |
| values.<DD><CODE>batchCapacity</CODE> - Estimated size of the batch.</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="isNull(org.objectstyle.cayenne.map.DbAttribute)"><!-- --></A><H3> |
| isNull</H3> |
| <PRE> |
| public boolean <B>isNull</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbAttribute.html" title="class in org.objectstyle.cayenne.map">DbAttribute</A> attribute)</PRE> |
| <DL> |
| <DD>Returns true if a given attribute always has a null value in the batch. |
| <P> |
| <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> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#isUsingOptimisticLocking()">isUsingOptimisticLocking</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUsingOptimisticLocking(boolean)"><!-- --></A><H3> |
| setUsingOptimisticLocking</H3> |
| <PRE> |
| public void <B>setUsingOptimisticLocking</B>(boolean usingOptimisticLocking)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getQualifierAttributes()"><!-- --></A><H3> |
| getQualifierAttributes</H3> |
| <PRE> |
| public java.util.List <B>getQualifierAttributes</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValue(int)"><!-- --></A><H3> |
| getValue</H3> |
| <PRE> |
| public java.lang.Object <B>getValue</B>(int dbAttributeIndex)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getValue(int)">BatchQuery</A></CODE></B></DD> |
| <DD>Returns a value at a given index for the current batch iteration. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getValue(int)">getValue</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="add(java.util.Map)"><!-- --></A><H3> |
| add</H3> |
| <PRE> |
| public void <B>add</B>(java.util.Map dataObjectId)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="size()"><!-- --></A><H3> |
| size</H3> |
| <PRE> |
| public int <B>size</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#size()">BatchQuery</A></CODE></B></DD> |
| <DD>Returns the number of parameter rows in a batch. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#size()">size</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDbAttributes()"><!-- --></A><H3> |
| getDbAttributes</H3> |
| <PRE> |
| public java.util.List <B>getDbAttributes</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getDbAttributes()">BatchQuery</A></CODE></B></DD> |
| <DD>Returns a list of DbAttributes describing batch parameters. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html#getDbAttributes()">getDbAttributes</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query">BatchQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrentQualifier()"><!-- --></A><H3> |
| getCurrentQualifier</H3> |
| <PRE> |
| public java.util.Map <B>getCurrentQualifier</B>()</PRE> |
| <DL> |
| <DD>Returns a snapshot of the current qualifier values. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/query/BatchQuery.html" title="class in org.objectstyle.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/query/DeleteQuery.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/DeleteBatchQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DeleteBatchQuery.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> |
