| <!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> |
| JDBCResultIterator (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.jdbc.JDBCResultIterator class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="JDBCResultIterator (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/jdbc/ColumnDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/ParameterBinding.html" title="class in org.objectstyle.cayenne.access.jdbc"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JDBCResultIterator.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.jdbc</FONT> |
| <BR> |
| Class JDBCResultIterator</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.jdbc.JDBCResultIterator</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>JDBCResultIterator</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></DL> |
| </PRE> |
| |
| <P> |
| A ResultIterator over the underlying JDBC ResultSet. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Andrus Adamchik</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#closed">closed</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/access/jdbc/JDBCResultIterator.html#closingConnection">closingConnection</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.sql.Connection</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#connection">connection</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </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/access/jdbc/JDBCResultIterator.html#fetchedSoFar">fetchedSoFar</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </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/access/jdbc/JDBCResultIterator.html#fetchLimit">fetchLimit</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </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/access/jdbc/JDBCResultIterator.html#mapCapacity">mapCapacity</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/access/jdbc/JDBCResultIterator.html#nextRow">nextRow</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </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/access/jdbc/JDBCResultIterator.html#pkIndices">pkIndices</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.sql.ResultSet</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#resultSet">resultSet</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#rootEntity">rootEntity</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/RowDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc">RowDescriptor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#rowDescriptor">rowDescriptor</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.sql.Statement</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#statement">statement</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/jdbc/JDBCResultIterator.html#JDBCResultIterator(java.sql.Connection, java.sql.Statement, java.sql.ResultSet, org.objectstyle.cayenne.access.jdbc.RowDescriptor, int)">JDBCResultIterator</A></B>(java.sql.Connection connection, |
| java.sql.Statement statement, |
| java.sql.ResultSet resultSet, |
| <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/RowDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc">RowDescriptor</A> descriptor, |
| int fetchLimit)</CODE> |
| |
| <BR> |
| Creates new JDBCResultIterator that reads from provided ResultSet.</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 void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#checkNextRow()">checkNextRow</A></B>()</CODE> |
| |
| <BR> |
| Moves internal ResultSet cursor position down one 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/access/jdbc/JDBCResultIterator.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Closes ResultIterator and associated ResultSet.</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/jdbc/JDBCResultIterator.html#dataRows(boolean)">dataRows</A></B>(boolean close)</CODE> |
| |
| <BR> |
| Returns all unread data rows from ResultSet, closing this iterator if needed.</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/jdbc/JDBCResultIterator.html#getDataRowWidth()">getDataRowWidth</A></B>()</CODE> |
| |
| <BR> |
| Returns the number of columns in the result row.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/RowDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc">RowDescriptor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#getRowDescriptor()">getRowDescriptor</A></B>()</CODE> |
| |
| <BR> |
| </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/jdbc/JDBCResultIterator.html#hasNextRow()">hasNextRow</A></B>()</CODE> |
| |
| <BR> |
| Returns true if there is at least one more record that can be read from the |
| iterator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#indexPK()">indexPK</A></B>()</CODE> |
| |
| <BR> |
| Creates an index of PK columns in the RowDescriptor.</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/jdbc/JDBCResultIterator.html#isClosingConnection()">isClosingConnection</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this iterator is responsible for closing its |
| connection, otherwise a user of the iterator must close the connection after |
| closing the iterator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#nextDataRow()">nextDataRow</A></B>()</CODE> |
| |
| <BR> |
| Returns the next result row as a Map.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#nextObjectId(org.objectstyle.cayenne.map.DbEntity)">nextObjectId</A></B>(<A HREF="../../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity)</CODE> |
| |
| <BR> |
| Returns a map of ObjectId values from the next result row.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#readDataRow()">readDataRow</A></B>()</CODE> |
| |
| <BR> |
| Reads a row from the internal ResultSet at the current cursor position.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html#readIdRow()">readIdRow</A></B>()</CODE> |
| |
| <BR> |
| Reads a row from the internal ResultSet at the current cursor position, processing |
| only columns that are part of the ObjectId of a target class.</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/jdbc/JDBCResultIterator.html#setClosingConnection(boolean)">setClosingConnection</A></B>(boolean flag)</CODE> |
| |
| <BR> |
| Sets the <code>closingConnection</code> property.</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/jdbc/JDBCResultIterator.html#skipDataRow()">skipDataRow</A></B>()</CODE> |
| |
| <BR> |
| Skips current data row instead of reading it.</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="connection"><!-- --></A><H3> |
| connection</H3> |
| <PRE> |
| protected java.sql.Connection <B>connection</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="statement"><!-- --></A><H3> |
| statement</H3> |
| <PRE> |
| protected java.sql.Statement <B>statement</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="resultSet"><!-- --></A><H3> |
| resultSet</H3> |
| <PRE> |
| protected java.sql.ResultSet <B>resultSet</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="rowDescriptor"><!-- --></A><H3> |
| rowDescriptor</H3> |
| <PRE> |
| protected <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/RowDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc">RowDescriptor</A> <B>rowDescriptor</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="rootEntity"><!-- --></A><H3> |
| rootEntity</H3> |
| <PRE> |
| protected <A HREF="../../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> <B>rootEntity</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="pkIndices"><!-- --></A><H3> |
| pkIndices</H3> |
| <PRE> |
| protected int[] <B>pkIndices</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="mapCapacity"><!-- --></A><H3> |
| mapCapacity</H3> |
| <PRE> |
| protected int <B>mapCapacity</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="closingConnection"><!-- --></A><H3> |
| closingConnection</H3> |
| <PRE> |
| protected boolean <B>closingConnection</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="closed"><!-- --></A><H3> |
| closed</H3> |
| <PRE> |
| protected boolean <B>closed</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="nextRow"><!-- --></A><H3> |
| nextRow</H3> |
| <PRE> |
| protected boolean <B>nextRow</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchedSoFar"><!-- --></A><H3> |
| fetchedSoFar</H3> |
| <PRE> |
| protected int <B>fetchedSoFar</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchLimit"><!-- --></A><H3> |
| fetchLimit</H3> |
| <PRE> |
| protected int <B>fetchLimit</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="JDBCResultIterator(java.sql.Connection, java.sql.Statement, java.sql.ResultSet, org.objectstyle.cayenne.access.jdbc.RowDescriptor, int)"><!-- --></A><H3> |
| JDBCResultIterator</H3> |
| <PRE> |
| public <B>JDBCResultIterator</B>(java.sql.Connection connection, |
| java.sql.Statement statement, |
| java.sql.ResultSet resultSet, |
| <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/RowDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc">RowDescriptor</A> descriptor, |
| int fetchLimit) |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Creates new JDBCResultIterator that reads from provided ResultSet. |
| <P> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></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="dataRows(boolean)"><!-- --></A><H3> |
| dataRows</H3> |
| <PRE> |
| public java.util.List <B>dataRows</B>(boolean close) |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Returns all unread data rows from ResultSet, closing this iterator if needed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#dataRows(boolean)">dataRows</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasNextRow()"><!-- --></A><H3> |
| hasNextRow</H3> |
| <PRE> |
| public boolean <B>hasNextRow</B>()</PRE> |
| <DL> |
| <DD>Returns true if there is at least one more record that can be read from the |
| iterator. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#hasNextRow()">hasNextRow</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="nextDataRow()"><!-- --></A><H3> |
| nextDataRow</H3> |
| <PRE> |
| public java.util.Map <B>nextDataRow</B>() |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Returns the next result row as a Map. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#nextDataRow()">nextDataRow</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="nextObjectId(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> |
| nextObjectId</H3> |
| <PRE> |
| public java.util.Map <B>nextObjectId</B>(<A HREF="../../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity) |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Returns a map of ObjectId values from the next result row. Primary key columns are |
| determined from the provided DbEntity. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#nextObjectId(org.objectstyle.cayenne.map.DbEntity)">nextObjectId</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="skipDataRow()"><!-- --></A><H3> |
| skipDataRow</H3> |
| <PRE> |
| public void <B>skipDataRow</B>() |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#skipDataRow()">ResultIterator</A></CODE></B></DD> |
| <DD>Skips current data row instead of reading it. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#skipDataRow()">skipDataRow</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| public void <B>close</B>() |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Closes ResultIterator and associated ResultSet. This method must be called |
| explicitly when the user is finished processing the records. Otherwise unused |
| database resources will not be released properly. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDataRowWidth()"><!-- --></A><H3> |
| getDataRowWidth</H3> |
| <PRE> |
| public int <B>getDataRowWidth</B>()</PRE> |
| <DL> |
| <DD>Returns the number of columns in the result row. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html#getDataRowWidth()">getDataRowWidth</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/access/ResultIterator.html" title="interface in org.objectstyle.cayenne.access">ResultIterator</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="checkNextRow()"><!-- --></A><H3> |
| checkNextRow</H3> |
| <PRE> |
| protected void <B>checkNextRow</B>() |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Moves internal ResultSet cursor position down one row. Checks if the next row is |
| available. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readDataRow()"><!-- --></A><H3> |
| readDataRow</H3> |
| <PRE> |
| protected java.util.Map <B>readDataRow</B>() |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Reads a row from the internal ResultSet at the current cursor position. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readIdRow()"><!-- --></A><H3> |
| readIdRow</H3> |
| <PRE> |
| protected java.util.Map <B>readIdRow</B>() |
| throws <A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> |
| <DL> |
| <DD>Reads a row from the internal ResultSet at the current cursor position, processing |
| only columns that are part of the ObjectId of a target class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="indexPK()"><!-- --></A><H3> |
| indexPK</H3> |
| <PRE> |
| protected void <B>indexPK</B>()</PRE> |
| <DL> |
| <DD>Creates an index of PK columns in the RowDescriptor. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isClosingConnection()"><!-- --></A><H3> |
| isClosingConnection</H3> |
| <PRE> |
| public boolean <B>isClosingConnection</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if this iterator is responsible for closing its |
| connection, otherwise a user of the iterator must close the connection after |
| closing the iterator. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setClosingConnection(boolean)"><!-- --></A><H3> |
| setClosingConnection</H3> |
| <PRE> |
| public void <B>setClosingConnection</B>(boolean flag)</PRE> |
| <DL> |
| <DD>Sets the <code>closingConnection</code> property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRowDescriptor()"><!-- --></A><H3> |
| getRowDescriptor</H3> |
| <PRE> |
| public <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/RowDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc">RowDescriptor</A> <B>getRowDescriptor</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.objectstyle.cayenne.access.jdbc"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/objectstyle/cayenne/access/jdbc/ParameterBinding.html" title="class in org.objectstyle.cayenne.access.jdbc"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/objectstyle/cayenne/access/jdbc/JDBCResultIterator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JDBCResultIterator.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> |
