http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoader.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoader.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoader.html new file mode 100644 index 0000000..4a988f5 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoader.html @@ -0,0 +1,796 @@ +<!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> +DbLoader (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DbLoader class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DbLoader (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/DbGenerator.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DbLoader.html" target="_top"><B>FRAMES</B></A> + <A HREF="DbLoader.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne.access</FONT> +<BR> +Class DbLoader</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.DbLoader</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>DbLoader</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Utility class that does reverse engineering of the database. It can create DataMaps + using database meta data obtained via JDBC driver. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Michael Shengaout, Andrei 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 <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#adapter">adapter</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/DbLoader.html#con">con</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/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access">DbLoaderDelegate</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#delegate">delegate</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#genericClassName">genericClassName</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.DatabaseMetaData</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#metaData">metaData</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#WILDCARD">WILDCARD</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/DbLoader.html#DbLoader(java.sql.Connection, org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.access.DbLoaderDelegate)">DbLoader</A></B>(java.sql.Connection con, + <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/access/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access">DbLoaderDelegate</A> delegate)</CODE> + +<BR> + Creates new DbLoader.</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/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#getAdapter()">getAdapter</A></B>()</CODE> + +<BR> + Returns DbAdapter associated with this DbLoader.</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/DbLoader.html#getCatalogs()">getCatalogs</A></B>()</CODE> + +<BR> + Retrieves catalogues for the database associated with this DbLoader.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.sql.Connection</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#getCon()">getCon</A></B>()</CODE> + +<BR> + Returns database connection used by this DbLoader.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#getGenericClassName()">getGenericClassName</A></B>()</CODE> + +<BR> + Returns a name of a generic class that should be used for all ObjEntities.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.sql.DatabaseMetaData</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#getMetaData()">getMetaData</A></B>()</CODE> + +<BR> + Returns DatabaseMetaData object associated with this DbLoader.</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/DbLoader.html#getSchemas()">getSchemas</A></B>()</CODE> + +<BR> + Retrieves the schemas for the database.</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/DbLoader.html#getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">getTables</A></B>(java.lang.String catalog, + java.lang.String schemaPattern, + java.lang.String tableNamePattern, + java.lang.String[] types)</CODE> + +<BR> + Returns all table names for given combination of the criteria.</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/DbLoader.html#getTableTypes()">getTableTypes</A></B>()</CODE> + +<BR> + Returns all the table types for the given database.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#loadDataMapFromDB(java.lang.String, java.lang.String, org.objectstyle.cayenne.map.DataMap)">loadDataMapFromDB</A></B>(java.lang.String schemaName, + java.lang.String tablePattern, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap)</CODE> + +<BR> + Performs database reverse engineering and generates DataMap that contains default + mapping of the tables and views.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html#loadDataMapFromDB(java.lang.String, java.lang.String, java.lang.String[], org.objectstyle.cayenne.map.DataMap)">loadDataMapFromDB</A></B>(java.lang.String schemaName, + java.lang.String tablePattern, + java.lang.String[] tableTypes, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap)</CODE> + +<BR> + Performs database reverse engineering and generates DataMap object that contains + default mapping of the tables and views.</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/DbLoader.html#loadDbEntities(org.objectstyle.cayenne.map.DataMap, java.util.List)">loadDbEntities</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map, + java.util.List tables)</CODE> + +<BR> + Loads dbEntities for the specified tables.</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/DbLoader.html#loadDbRelationships(org.objectstyle.cayenne.map.DataMap)">loadDbRelationships</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map)</CODE> + +<BR> + Loads database relationships into a DataMap.</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/DbLoader.html#loadObjEntities(org.objectstyle.cayenne.map.DataMap)">loadObjEntities</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map)</CODE> + +<BR> + Creates an ObjEntity for each DbEntity in the map.</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/DbLoader.html#loadProceduresFromDB(java.lang.String, java.lang.String, org.objectstyle.cayenne.map.DataMap)">loadProceduresFromDB</A></B>(java.lang.String schemaPattern, + java.lang.String namePattern, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap)</CODE> + +<BR> + Loads database stored procedures into the DataMap.</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/DbLoader.html#postprocessMasterDbRelationship(org.objectstyle.cayenne.map.DbRelationship)">postprocessMasterDbRelationship</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbRelationship.html" title="class in org.objectstyle.cayenne.map">DbRelationship</A> relationship)</CODE> + +<BR> + Detects correct relationship multiplicity and "to dep pk" flag.</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/DbLoader.html#setGenericClassName(java.lang.String)">setGenericClassName</A></B>(java.lang.String genericClassName)</CODE> + +<BR> + Sets a name of a generic class that should be used for all ObjEntities.</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="WILDCARD"><!-- --></A><H3> +WILDCARD</H3> +<PRE> +public static final java.lang.String <B>WILDCARD</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DbLoader.WILDCARD">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="con"><!-- --></A><H3> +con</H3> +<PRE> +protected java.sql.Connection <B>con</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="adapter"><!-- --></A><H3> +adapter</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> <B>adapter</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="metaData"><!-- --></A><H3> +metaData</H3> +<PRE> +protected java.sql.DatabaseMetaData <B>metaData</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="delegate"><!-- --></A><H3> +delegate</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access">DbLoaderDelegate</A> <B>delegate</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="genericClassName"><!-- --></A><H3> +genericClassName</H3> +<PRE> +protected java.lang.String <B>genericClassName</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="DbLoader(java.sql.Connection, org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.access.DbLoaderDelegate)"><!-- --></A><H3> +DbLoader</H3> +<PRE> +public <B>DbLoader</B>(java.sql.Connection con, + <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/access/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access">DbLoaderDelegate</A> delegate)</PRE> +<DL> +<DD>Creates new DbLoader. +<P> +</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="getMetaData()"><!-- --></A><H3> +getMetaData</H3> +<PRE> +public java.sql.DatabaseMetaData <B>getMetaData</B>() + throws java.sql.SQLException</PRE> +<DL> +<DD>Returns DatabaseMetaData object associated with this DbLoader. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getCon()"><!-- --></A><H3> +getCon</H3> +<PRE> +public java.sql.Connection <B>getCon</B>()</PRE> +<DL> +<DD>Returns database connection used by this DbLoader. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getGenericClassName()"><!-- --></A><H3> +getGenericClassName</H3> +<PRE> +public java.lang.String <B>getGenericClassName</B>()</PRE> +<DL> +<DD>Returns a name of a generic class that should be used for all ObjEntities. The most + common generic class is <A HREF="../../../../org/objectstyle/cayenne/CayenneDataObject.html" title="class in org.objectstyle.cayenne"><CODE>CayenneDataObject</CODE></A>. If + generic class name is null (which is the default), DbLoader will assign each entity + a unique class name derived from the table name. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setGenericClassName(java.lang.String)"><!-- --></A><H3> +setGenericClassName</H3> +<PRE> +public void <B>setGenericClassName</B>(java.lang.String genericClassName)</PRE> +<DL> +<DD>Sets a name of a generic class that should be used for all ObjEntities. The most + common generic class is <A HREF="../../../../org/objectstyle/cayenne/CayenneDataObject.html" title="class in org.objectstyle.cayenne"><CODE>CayenneDataObject</CODE></A>. If + generic class name is set to null (which is the default), DbLoader will assign each + entity a unique class name derived from the table name. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getAdapter()"><!-- --></A><H3> +getAdapter</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> <B>getAdapter</B>()</PRE> +<DL> +<DD>Returns DbAdapter associated with this DbLoader. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getCatalogs()"><!-- --></A><H3> +getCatalogs</H3> +<PRE> +public java.util.List <B>getCatalogs</B>() + throws java.sql.SQLException</PRE> +<DL> +<DD>Retrieves catalogues for the database associated with this DbLoader. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>List with the catalog names, empty Array if none found. +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getSchemas()"><!-- --></A><H3> +getSchemas</H3> +<PRE> +public java.util.List <B>getSchemas</B>() + throws java.sql.SQLException</PRE> +<DL> +<DD>Retrieves the schemas for the database. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>List with the schema names, empty Array if none found. +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getTableTypes()"><!-- --></A><H3> +getTableTypes</H3> +<PRE> +public java.util.List <B>getTableTypes</B>() + throws java.sql.SQLException</PRE> +<DL> +<DD>Returns all the table types for the given database. Types may be such as "TABLE", + "VIEW", "SYSTEM TABLE", etc. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>List of Strings, empty array if nothing found. +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3> +getTables</H3> +<PRE> +public java.util.List <B>getTables</B>(java.lang.String catalog, + java.lang.String schemaPattern, + java.lang.String tableNamePattern, + java.lang.String[] types) + throws java.sql.SQLException</PRE> +<DL> +<DD>Returns all table names for given combination of the criteria. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>catalog</CODE> - The name of the catalog, may be null.<DD><CODE>schemaPattern</CODE> - The pattern for schema name, use "%" for wildcard.<DD><CODE>tableNamePattern</CODE> - The pattern for table names, % for wildcard, if null or "" + defaults to "%".<DD><CODE>types</CODE> - The types of table names to retrieve, null returns all types. +<DT><B>Returns:</B><DD>List of TableInfo objects, empty array if nothing found. +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="loadDbEntities(org.objectstyle.cayenne.map.DataMap, java.util.List)"><!-- --></A><H3> +loadDbEntities</H3> +<PRE> +public boolean <B>loadDbEntities</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map, + java.util.List tables) + throws java.sql.SQLException</PRE> +<DL> +<DD>Loads dbEntities for the specified tables. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>map</CODE> - DataMap to be populated with DbEntities.<DD><CODE>tables</CODE> - The list of org.objectstyle.ashwood.dbutil.Table objects for which + DbEntities must be created. +<DT><B>Returns:</B><DD>false if loading must be immediately aborted. +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="loadObjEntities(org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +loadObjEntities</H3> +<PRE> +public void <B>loadObjEntities</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map)</PRE> +<DL> +<DD>Creates an ObjEntity for each DbEntity in the map. ObjEntities are created empty + without +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="loadDbRelationships(org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +loadDbRelationships</H3> +<PRE> +public void <B>loadDbRelationships</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map) + throws java.sql.SQLException</PRE> +<DL> +<DD>Loads database relationships into a DataMap. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="postprocessMasterDbRelationship(org.objectstyle.cayenne.map.DbRelationship)"><!-- --></A><H3> +postprocessMasterDbRelationship</H3> +<PRE> +protected void <B>postprocessMasterDbRelationship</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbRelationship.html" title="class in org.objectstyle.cayenne.map">DbRelationship</A> relationship)</PRE> +<DL> +<DD>Detects correct relationship multiplicity and "to dep pk" flag. Only called on + relationships from PK to FK, not the reverse ones. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="loadDataMapFromDB(java.lang.String, java.lang.String, org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +loadDataMapFromDB</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> <B>loadDataMapFromDB</B>(java.lang.String schemaName, + java.lang.String tablePattern, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap) + throws java.sql.SQLException</PRE> +<DL> +<DD>Performs database reverse engineering and generates DataMap that contains default + mapping of the tables and views. By default will include regular tables and views. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE><DT><B>Since:</B></DT> + <DD>1.0.7</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="loadDataMapFromDB(java.lang.String, java.lang.String, java.lang.String[], org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +loadDataMapFromDB</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> <B>loadDataMapFromDB</B>(java.lang.String schemaName, + java.lang.String tablePattern, + java.lang.String[] tableTypes, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap) + throws java.sql.SQLException</PRE> +<DL> +<DD>Performs database reverse engineering and generates DataMap object that contains + default mapping of the tables and views. Allows to limit types of tables to read. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="loadProceduresFromDB(java.lang.String, java.lang.String, org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +loadProceduresFromDB</H3> +<PRE> +public void <B>loadProceduresFromDB</B>(java.lang.String schemaPattern, + java.lang.String namePattern, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> dataMap) + throws java.sql.SQLException</PRE> +<DL> +<DD>Loads database stored procedures into the DataMap. + <p> + <i>As of 1.1 there is no boolean property or delegate method to make procedure + loading optional or to implement custom merging logic, so currently this method is + NOT CALLED from "loadDataMapFromDB" and should be invoked explicitly by the user. + </i> + </p> +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE><DT><B>Since:</B></DT> + <DD>1.1</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/access/DbGenerator.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DbLoader.html" target="_top"><B>FRAMES</B></A> + <A HREF="DbLoader.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoaderDelegate.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoaderDelegate.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoaderDelegate.html new file mode 100644 index 0000000..26e1234 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbLoaderDelegate.html @@ -0,0 +1,298 @@ +<!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> +DbLoaderDelegate (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DbLoaderDelegate interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DbLoaderDelegate (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/DbLoader.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DefaultResultIterator.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DbLoaderDelegate.html" target="_top"><B>FRAMES</B></A> + <A HREF="DbLoaderDelegate.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne.access</FONT> +<BR> +Interface DbLoaderDelegate</H2> +<HR> +<DL> +<DT><PRE>public interface <B>DbLoaderDelegate</B></DL> +</PRE> + +<P> +DbLoaderDelegate defines API that allows to control the behavior of DbLoader during the + database reverse-engineering. Delegate is also notified of the progress of + reverse-engineering. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrei Adamchik</DD> +</DL> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbLoaderDelegate.html#dbEntityAdded(org.objectstyle.cayenne.map.DbEntity)">dbEntityAdded</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> ent)</CODE> + +<BR> + </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/DbLoaderDelegate.html#dbEntityRemoved(org.objectstyle.cayenne.map.DbEntity)">dbEntityRemoved</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> ent)</CODE> + +<BR> + </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/DbLoaderDelegate.html#objEntityAdded(org.objectstyle.cayenne.map.ObjEntity)">objEntityAdded</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> ent)</CODE> + +<BR> + </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/DbLoaderDelegate.html#objEntityRemoved(org.objectstyle.cayenne.map.ObjEntity)">objEntityRemoved</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> ent)</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/DbLoaderDelegate.html#overwriteDbEntity(org.objectstyle.cayenne.map.DbEntity)">overwriteDbEntity</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> ent)</CODE> + +<BR> + Returns true to tell DbLoader that it is OK to overwrite DbEntity that already + exists in the model.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="overwriteDbEntity(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +overwriteDbEntity</H3> +<PRE> +boolean <B>overwriteDbEntity</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> ent) + throws <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD>Returns true to tell DbLoader that it is OK to overwrite DbEntity that already + exists in the model. If loading process should be stopped immediately, an exception + is thrown. +<P> +<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="dbEntityAdded(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +dbEntityAdded</H3> +<PRE> +void <B>dbEntityAdded</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> ent)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="dbEntityRemoved(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +dbEntityRemoved</H3> +<PRE> +void <B>dbEntityRemoved</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> ent)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="objEntityAdded(org.objectstyle.cayenne.map.ObjEntity)"><!-- --></A><H3> +objEntityAdded</H3> +<PRE> +void <B>objEntityAdded</B>(<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> ent)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="objEntityRemoved(org.objectstyle.cayenne.map.ObjEntity)"><!-- --></A><H3> +objEntityRemoved</H3> +<PRE> +void <B>objEntityRemoved</B>(<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> ent)</PRE> +<DL> +<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/DbLoader.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DefaultResultIterator.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DbLoaderDelegate.html" target="_top"><B>FRAMES</B></A> + <A HREF="DbLoaderDelegate.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DefaultResultIterator.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DefaultResultIterator.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DefaultResultIterator.html new file mode 100644 index 0000000..d1083e3 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DefaultResultIterator.html @@ -0,0 +1,834 @@ +<!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> +DefaultResultIterator (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DefaultResultIterator class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DefaultResultIterator (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/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DeleteDenyException.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DefaultResultIterator.html" target="_top"><B>FRAMES</B></A> + <A HREF="DefaultResultIterator.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.objectstyle.cayenne.access</FONT> +<BR> +Class DefaultResultIterator</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.DefaultResultIterator</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> +<B>Deprecated.</B> <I>Since 1.2 replaced by JDBCResultIterator.</I> +<P> +<DL> +<DT><PRE>public class <B>DefaultResultIterator</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> +Default implementation of ResultIterator interface. Serves as a + factory that creates data rows from <code>java.sql.ResultSet</code>. + + <p><i>For more information see <a href="../../../../../../userguide/index.html" + target="_top">Cayenne User Guide.</a></i></p> +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Andrei Adamchik</DD> +</DL> +<HR> + +<P> +<!-- =========== 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/DefaultResultIterator.html#closingConnection">closingConnection</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#connection">connection</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/util/ResultDescriptor.html" title="class in org.objectstyle.cayenne.access.util">ResultDescriptor</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DefaultResultIterator.html#descriptor">descriptor</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#fetchedSoFar">fetchedSoFar</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#fetchLimit">fetchLimit</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#isClosed">isClosed</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#mapCapacity">mapCapacity</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#nextRow">nextRow</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#resultSet">resultSet</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#statement">statement</A></B></CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#DefaultResultIterator(java.sql.Connection, java.sql.Statement, java.sql.ResultSet, org.objectstyle.cayenne.access.util.ResultDescriptor, int)">DefaultResultIterator</A></B>(java.sql.Connection connection, + java.sql.Statement statement, + java.sql.ResultSet resultSet, + <A HREF="../../../../org/objectstyle/cayenne/access/util/ResultDescriptor.html" title="class in org.objectstyle.cayenne.access.util">ResultDescriptor</A> descriptor, + int fetchLimit)</CODE> + +<BR> + <B>Deprecated.</B> </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/DefaultResultIterator.html#checkNextRow()">checkNextRow</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.html#close()">close</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.html#dataRows(boolean)">dataRows</A></B>(boolean close)</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.html#getDataRowWidth()">getDataRowWidth</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DefaultResultIterator.html#hasNextRow()">hasNextRow</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DefaultResultIterator.html#isClosingConnection()">isClosingConnection</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.html#nextDataRow()">nextDataRow</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.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> + <B>Deprecated.</B> 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/DefaultResultIterator.html#readDataRow()">readDataRow</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.html#readIdRow(org.objectstyle.cayenne.map.DbEntity)">readIdRow</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity)</CODE> + +<BR> + <B>Deprecated.</B> 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>static java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DefaultResultIterator.html#readProcedureOutParameters(java.sql.CallableStatement, org.objectstyle.cayenne.access.util.ResultDescriptor)">readProcedureOutParameters</A></B>(java.sql.CallableStatement statement, + <A HREF="../../../../org/objectstyle/cayenne/access/util/ResultDescriptor.html" title="class in org.objectstyle.cayenne.access.util">ResultDescriptor</A> resultDescriptor)</CODE> + +<BR> + <B>Deprecated.</B> Utility method to read stored procedure out parameters as a map.</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/DefaultResultIterator.html#setClosingConnection(boolean)">setClosingConnection</A></B>(boolean flag)</CODE> + +<BR> + <B>Deprecated.</B> 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/DefaultResultIterator.html#skipDataRow()">skipDataRow</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> 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> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="statement"><!-- --></A><H3> +statement</H3> +<PRE> +protected java.sql.Statement <B>statement</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="resultSet"><!-- --></A><H3> +resultSet</H3> +<PRE> +protected java.sql.ResultSet <B>resultSet</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="descriptor"><!-- --></A><H3> +descriptor</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/util/ResultDescriptor.html" title="class in org.objectstyle.cayenne.access.util">ResultDescriptor</A> <B>descriptor</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="mapCapacity"><!-- --></A><H3> +mapCapacity</H3> +<PRE> +protected int <B>mapCapacity</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="closingConnection"><!-- --></A><H3> +closingConnection</H3> +<PRE> +protected boolean <B>closingConnection</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="isClosed"><!-- --></A><H3> +isClosed</H3> +<PRE> +protected boolean <B>isClosed</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="nextRow"><!-- --></A><H3> +nextRow</H3> +<PRE> +protected boolean <B>nextRow</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="fetchedSoFar"><!-- --></A><H3> +fetchedSoFar</H3> +<PRE> +protected int <B>fetchedSoFar</B></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> +</DL> +</DL> +<HR> + +<A NAME="fetchLimit"><!-- --></A><H3> +fetchLimit</H3> +<PRE> +protected int <B>fetchLimit</B></PRE> +<DL> +<DD><B>Deprecated.</B> <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="DefaultResultIterator(java.sql.Connection, java.sql.Statement, java.sql.ResultSet, org.objectstyle.cayenne.access.util.ResultDescriptor, int)"><!-- --></A><H3> +DefaultResultIterator</H3> +<PRE> +public <B>DefaultResultIterator</B>(java.sql.Connection connection, + java.sql.Statement statement, + java.sql.ResultSet resultSet, + <A HREF="../../../../org/objectstyle/cayenne/access/util/ResultDescriptor.html" title="class in org.objectstyle.cayenne.access.util">ResultDescriptor</A> descriptor, + int fetchLimit) + throws java.sql.SQLException, + <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD><B>Deprecated.</B> <DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE> +<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="readProcedureOutParameters(java.sql.CallableStatement, org.objectstyle.cayenne.access.util.ResultDescriptor)"><!-- --></A><H3> +readProcedureOutParameters</H3> +<PRE> +public static java.util.Map <B>readProcedureOutParameters</B>(java.sql.CallableStatement statement, + <A HREF="../../../../org/objectstyle/cayenne/access/util/ResultDescriptor.html" title="class in org.objectstyle.cayenne.access.util">ResultDescriptor</A> resultDescriptor) + throws java.sql.SQLException, + java.lang.Exception</PRE> +<DL> +<DD><B>Deprecated.</B> <DD>Utility method to read stored procedure out parameters as a map. + Returns an empty map if no out parameters exist. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE> +<DD><CODE>java.lang.Exception</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="checkNextRow()"><!-- --></A><H3> +checkNextRow</H3> +<PRE> +protected void <B>checkNextRow</B>() + throws java.sql.SQLException, + <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD><B>Deprecated.</B> <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>java.sql.SQLException</CODE> +<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><B>Deprecated.</B> <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><B>Deprecated.</B> <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="getDataRowWidth()"><!-- --></A><H3> +getDataRowWidth</H3> +<PRE> +public int <B>getDataRowWidth</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <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> +<DT><B>Since:</B></DT> + <DD>1.0.6</DD> +</DL> +</DD> +</DL> +<HR> + +<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><B>Deprecated.</B> <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="readDataRow()"><!-- --></A><H3> +readDataRow</H3> +<PRE> +protected java.util.Map <B>readDataRow</B>() + throws java.sql.SQLException, + <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD><B>Deprecated.</B> <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>java.sql.SQLException</CODE> +<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(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +readIdRow</H3> +<PRE> +protected java.util.Map <B>readIdRow</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity) + throws java.sql.SQLException, + <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD><B>Deprecated.</B> <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>java.sql.SQLException</CODE> +<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><B>Deprecated.</B> <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="isClosingConnection()"><!-- --></A><H3> +isClosingConnection</H3> +<PRE> +public boolean <B>isClosingConnection</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <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><B>Deprecated.</B> <DD>Sets the <code>closingConnection</code> property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</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>Deprecated.</B> <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><DT><B>See Also:</B><DD><A HREF="../../../../org/objectstyle/cayenne/access/ResultIterator.html#skipDataRow()"><CODE>ResultIterator.skipDataRow()</CODE></A></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><B>Deprecated.</B> <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><DT><B>Since:</B></DT> + <DD>1.1</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/access/DbLoaderDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DeleteDenyException.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DefaultResultIterator.html" target="_top"><B>FRAMES</B></A> + <A HREF="DefaultResultIterator.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>
