| <!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:45:48 EDT 2006 --> |
| <TITLE> |
| DbAdapter (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.dba.DbAdapter interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="DbAdapter (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </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/apache/cayenne/dba/AutoAdapter.html" title="class in org.apache.cayenne.dba"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/dba/DbAdapterFactory.html" title="interface in org.apache.cayenne.dba"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/dba/DbAdapter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DbAdapter.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.apache.cayenne.dba</FONT> |
| <BR> |
| Interface DbAdapter</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/cayenne/dba/AutoAdapter.html" title="class in org.apache.cayenne.dba">AutoAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/db2/DB2Adapter.html" title="class in org.apache.cayenne.dba.db2">DB2Adapter</A>, <A HREF="../../../../org/apache/cayenne/dba/derby/DerbyAdapter.html" title="class in org.apache.cayenne.dba.derby">DerbyAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/firebird/FirebirdAdapter.html" title="class in org.apache.cayenne.dba.firebird">FirebirdAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/frontbase/FrontBaseAdapter.html" title="class in org.apache.cayenne.dba.frontbase">FrontBaseAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/hsqldb/HSQLDBAdapter.html" title="class in org.apache.cayenne.dba.hsqldb">HSQLDBAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/hsqldb/HSQLDBNoSchemaAdapter.html" title="class in org.apache.cayenne.dba.hsqldb">HSQLDBNoSchemaAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/ingres/IngresAdapter.html" title="class in org.apache.cayenne.dba.ingres">IngresAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/mysql/MySQLAdapter.html" title="class in org.apache.cayenne.dba.mysql">MySQLAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/openbase/OpenBaseAdapter.html" title="class in org.apache.cayenne.dba.openbase">OpenBaseAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/oracle/Oracle8Adapter.html" title="class in org.apache.cayenne.dba.oracle">Oracle8Adapter</A>, <A HREF="../../../../org/apache/cayenne/dba/oracle/OracleAdapter.html" title="class in org.apache.cayenne.dba.oracle">OracleAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/postgres/PostgresAdapter.html" title="class in org.apache.cayenne.dba.postgres">PostgresAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/sqlserver/SQLServerAdapter.html" title="class in org.apache.cayenne.dba.sqlserver">SQLServerAdapter</A>, <A HREF="../../../../org/apache/cayenne/dba/sybase/SybaseAdapter.html" title="class in org.apache.cayenne.dba.sybase">SybaseAdapter</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>DbAdapter</B></DL> |
| </PRE> |
| |
| <P> |
| Defines API needed to handle differences between various databases accessed via JDBC. |
| Implementing classed are intended to be pluggable database-specific adapters. |
| DbAdapter-based architecture is introduced to solve the following problems: |
| <ul> |
| <li>Make Cayenne code independent from SQL syntax differences between different RDBMS. |
| <li>Allow for vendor-specific tuning of JDBC access. |
| </ul> |
| <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/apache/cayenne/dba/DbAdapter.html#bindParameter(java.sql.PreparedStatement, java.lang.Object, int, int, int)">bindParameter</A></B>(java.sql.PreparedStatement statement, |
| java.lang.Object object, |
| int pos, |
| int sqlType, |
| int precision)</CODE> |
| |
| <BR> |
| Binds an object value to PreparedStatement's numbered parameter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#buildAttribute(java.lang.String, java.lang.String, int, int, int, boolean)">buildAttribute</A></B>(java.lang.String name, |
| java.lang.String typeName, |
| int type, |
| int size, |
| int precision, |
| boolean allowNulls)</CODE> |
| |
| <BR> |
| Creates and returns a DbAttribute based on supplied parameters (usually obtained |
| from database meta data).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#createDataNode(java.lang.String)">createDataNode</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 this method is not used as node behavior customization is |
| done via SQLActionVisitor.</I></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/apache/cayenne/dba/DbAdapter.html#createFkConstraint(org.apache.cayenne.map.DbRelationship)">createFkConstraint</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A> rel)</CODE> |
| |
| <BR> |
| Returns a SQL string that can be used to create a foreign key constraint for the |
| relationship.</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/apache/cayenne/dba/DbAdapter.html#createTable(org.apache.cayenne.map.DbEntity)">createTable</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity)</CODE> |
| |
| <BR> |
| Returns a SQL string that can be used to create database table corresponding to |
| <code>ent</code> parameter.</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/apache/cayenne/dba/DbAdapter.html#createUniqueConstraint(org.apache.cayenne.map.DbEntity, java.util.Collection)">createUniqueConstraint</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> source, |
| java.util.Collection columns)</CODE> |
| |
| <BR> |
| Returns a DDL string to create a unique constraint over a set of columns.</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/apache/cayenne/dba/DbAdapter.html#dropTable(org.apache.cayenne.map.DbEntity)">dropTable</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity)</CODE> |
| |
| <BR> |
| Returns a SQL string that can be used to drop a database table corresponding to |
| <code>ent</code> parameter.</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/apache/cayenne/dba/DbAdapter.html#externalTypesForJdbcType(int)">externalTypesForJdbcType</A></B>(int type)</CODE> |
| |
| <BR> |
| Returns an array of RDBMS types that can be used with JDBC <code>type</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#getAction(org.apache.cayenne.query.Query, org.apache.cayenne.access.DataNode)">getAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query, |
| <A HREF="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</A> node)</CODE> |
| |
| <BR> |
| Returns an instance of SQLAction that should handle the query.</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/apache/cayenne/dba/DbAdapter.html#getBatchTerminator()">getBatchTerminator</A></B>()</CODE> |
| |
| <BR> |
| Returns a String used to terminate a batch in command-line tools.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/access/types/ExtendedTypeMap.html" title="class in org.apache.cayenne.access.types">ExtendedTypeMap</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#getExtendedTypes()">getExtendedTypes</A></B>()</CODE> |
| |
| <BR> |
| Returns a map of ExtendedTypes that is used to translate values between Java and |
| JDBC layer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/dba/PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#getPkGenerator()">getPkGenerator</A></B>()</CODE> |
| |
| <BR> |
| Returns primary key generator associated with this DbAdapter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/access/trans/QualifierTranslator.html" title="class in org.apache.cayenne.access.trans">QualifierTranslator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#getQualifierTranslator(org.apache.cayenne.access.trans.QueryAssembler)">getQualifierTranslator</A></B>(<A HREF="../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</A> queryAssembler)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/access/QueryTranslator.html" title="class in org.apache.cayenne.access">QueryTranslator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#getQueryTranslator(org.apache.cayenne.query.Query)">getQueryTranslator</A></B>(<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 this method is unneeded as customizations are done via custom |
| SQLActions.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#shouldRunBatchQuery(org.apache.cayenne.access.DataNode, java.sql.Connection, org.apache.cayenne.query.BatchQuery, org.apache.cayenne.access.OperationObserver)">shouldRunBatchQuery</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</A> node, |
| java.sql.Connection con, |
| <A HREF="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</A> query, |
| <A HREF="../../../../org/apache/cayenne/access/OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</A> delegate)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Since 1.2 this method is obsolete and is ignored across Cayenne.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/dba/DbAdapter.html#supportsBatchUpdates()">supportsBatchUpdates</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the target database supports batch updates.</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/apache/cayenne/dba/DbAdapter.html#supportsFkConstraints()">supportsFkConstraints</A></B>()</CODE> |
| |
| <BR> |
| Returns true if a target database supports FK constraints.</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/apache/cayenne/dba/DbAdapter.html#supportsGeneratedKeys()">supportsGeneratedKeys</A></B>()</CODE> |
| |
| <BR> |
| Returns true if a target database supports key autogeneration.</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/apache/cayenne/dba/DbAdapter.html#supportsUniqueConstraints()">supportsUniqueConstraints</A></B>()</CODE> |
| |
| <BR> |
| Returns true if a target database supports UNIQUE constraints.</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/apache/cayenne/dba/DbAdapter.html#tableTypeForTable()">tableTypeForTable</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a simple user table.</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/apache/cayenne/dba/DbAdapter.html#tableTypeForView()">tableTypeForView</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a view table.</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="getBatchTerminator()"><!-- --></A><H3> |
| getBatchTerminator</H3> |
| <PRE> |
| java.lang.String <B>getBatchTerminator</B>()</PRE> |
| <DL> |
| <DD>Returns a String used to terminate a batch in command-line tools. E.g. ";" on |
| Oracle or "go" on Sybase. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0.4</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createDataNode(java.lang.String)"><!-- --></A><H3> |
| createDataNode</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</A> <B>createDataNode</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 this method is not used as node behavior customization is |
| done via SQLActionVisitor.</I> |
| <P> |
| <DD>Creates an returns a named instance of a DataNode. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getQueryTranslator(org.apache.cayenne.query.Query)"><!-- --></A><H3> |
| getQueryTranslator</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/access/QueryTranslator.html" title="class in org.apache.cayenne.access">QueryTranslator</A> <B>getQueryTranslator</B>(<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 this method is unneeded as customizations are done via custom |
| SQLActions.</I> |
| <P> |
| <DD>Creates and returns a QueryTranslator appropriate for the specified |
| <code>query</code> parameter. Sets translator "query" and "adapter" property. |
| <p> |
| This factory method allows subclasses to specify their own translators that |
| implement vendor-specific optimizations. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getQualifierTranslator(org.apache.cayenne.access.trans.QueryAssembler)"><!-- --></A><H3> |
| getQualifierTranslator</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/access/trans/QualifierTranslator.html" title="class in org.apache.cayenne.access.trans">QualifierTranslator</A> <B>getQualifierTranslator</B>(<A HREF="../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</A> queryAssembler)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAction(org.apache.cayenne.query.Query, org.apache.cayenne.access.DataNode)"><!-- --></A><H3> |
| getAction</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>getAction</B>(<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query, |
| <A HREF="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</A> node)</PRE> |
| <DL> |
| <DD>Returns an instance of SQLAction that should handle the query. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsFkConstraints()"><!-- --></A><H3> |
| supportsFkConstraints</H3> |
| <PRE> |
| boolean <B>supportsFkConstraints</B>()</PRE> |
| <DL> |
| <DD>Returns true if a target database supports FK constraints. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsUniqueConstraints()"><!-- --></A><H3> |
| supportsUniqueConstraints</H3> |
| <PRE> |
| boolean <B>supportsUniqueConstraints</B>()</PRE> |
| <DL> |
| <DD>Returns true if a target database supports UNIQUE constraints. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsGeneratedKeys()"><!-- --></A><H3> |
| supportsGeneratedKeys</H3> |
| <PRE> |
| boolean <B>supportsGeneratedKeys</B>()</PRE> |
| <DL> |
| <DD>Returns true if a target database supports key autogeneration. This feature also |
| requires JDBC3-compliant driver. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsBatchUpdates()"><!-- --></A><H3> |
| supportsBatchUpdates</H3> |
| <PRE> |
| boolean <B>supportsBatchUpdates</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if the target database supports batch updates. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dropTable(org.apache.cayenne.map.DbEntity)"><!-- --></A><H3> |
| dropTable</H3> |
| <PRE> |
| java.lang.String <B>dropTable</B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity)</PRE> |
| <DL> |
| <DD>Returns a SQL string that can be used to drop a database table corresponding to |
| <code>ent</code> parameter. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createTable(org.apache.cayenne.map.DbEntity)"><!-- --></A><H3> |
| createTable</H3> |
| <PRE> |
| java.lang.String <B>createTable</B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity)</PRE> |
| <DL> |
| <DD>Returns a SQL string that can be used to create database table corresponding to |
| <code>ent</code> parameter. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createUniqueConstraint(org.apache.cayenne.map.DbEntity, java.util.Collection)"><!-- --></A><H3> |
| createUniqueConstraint</H3> |
| <PRE> |
| java.lang.String <B>createUniqueConstraint</B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> source, |
| java.util.Collection columns)</PRE> |
| <DL> |
| <DD>Returns a DDL string to create a unique constraint over a set of columns. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createFkConstraint(org.apache.cayenne.map.DbRelationship)"><!-- --></A><H3> |
| createFkConstraint</H3> |
| <PRE> |
| java.lang.String <B>createFkConstraint</B>(<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A> rel)</PRE> |
| <DL> |
| <DD>Returns a SQL string that can be used to create a foreign key constraint for the |
| relationship. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="externalTypesForJdbcType(int)"><!-- --></A><H3> |
| externalTypesForJdbcType</H3> |
| <PRE> |
| java.lang.String[] <B>externalTypesForJdbcType</B>(int type)</PRE> |
| <DL> |
| <DD>Returns an array of RDBMS types that can be used with JDBC <code>type</code>. |
| Valid JDBC types are defined in java.sql.Types. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExtendedTypes()"><!-- --></A><H3> |
| getExtendedTypes</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/access/types/ExtendedTypeMap.html" title="class in org.apache.cayenne.access.types">ExtendedTypeMap</A> <B>getExtendedTypes</B>()</PRE> |
| <DL> |
| <DD>Returns a map of ExtendedTypes that is used to translate values between Java and |
| JDBC layer. |
| <P> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><CODE>ExtendedType</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPkGenerator()"><!-- --></A><H3> |
| getPkGenerator</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/dba/PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</A> <B>getPkGenerator</B>()</PRE> |
| <DL> |
| <DD>Returns primary key generator associated with this DbAdapter. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="buildAttribute(java.lang.String, java.lang.String, int, int, int, boolean)"><!-- --></A><H3> |
| buildAttribute</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A> <B>buildAttribute</B>(java.lang.String name, |
| java.lang.String typeName, |
| int type, |
| int size, |
| int precision, |
| boolean allowNulls)</PRE> |
| <DL> |
| <DD>Creates and returns a DbAttribute based on supplied parameters (usually obtained |
| from database meta data). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - database column name<DD><CODE>typeName</CODE> - database specific type name, may be used as a hint to determine the |
| right JDBC type.<DD><CODE>type</CODE> - JDBC column type<DD><CODE>size</CODE> - database column size (ignored if less than zero)<DD><CODE>precision</CODE> - database column precision (ignored if less than zero)<DD><CODE>allowNulls</CODE> - database column nullable parameter</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="bindParameter(java.sql.PreparedStatement, java.lang.Object, int, int, int)"><!-- --></A><H3> |
| bindParameter</H3> |
| <PRE> |
| void <B>bindParameter</B>(java.sql.PreparedStatement statement, |
| java.lang.Object object, |
| int pos, |
| int sqlType, |
| int precision) |
| throws java.sql.SQLException, |
| java.lang.Exception</PRE> |
| <DL> |
| <DD>Binds an object value to PreparedStatement's numbered parameter. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.sql.SQLException</CODE> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="tableTypeForTable()"><!-- --></A><H3> |
| tableTypeForTable</H3> |
| <PRE> |
| java.lang.String <B>tableTypeForTable</B>()</PRE> |
| <DL> |
| <DD>Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a simple user table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="tableTypeForView()"><!-- --></A><H3> |
| tableTypeForView</H3> |
| <PRE> |
| java.lang.String <B>tableTypeForView</B>()</PRE> |
| <DL> |
| <DD>Returns the name of the table type (as returned by |
| <code>DatabaseMetaData.getTableTypes</code>) for a view table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="shouldRunBatchQuery(org.apache.cayenne.access.DataNode, java.sql.Connection, org.apache.cayenne.query.BatchQuery, org.apache.cayenne.access.OperationObserver)"><!-- --></A><H3> |
| shouldRunBatchQuery</H3> |
| <PRE> |
| boolean <B>shouldRunBatchQuery</B>(<A HREF="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</A> node, |
| java.sql.Connection con, |
| <A HREF="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</A> query, |
| <A HREF="../../../../org/apache/cayenne/access/OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</A> delegate) |
| throws java.sql.SQLException, |
| java.lang.Exception</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Since 1.2 this method is obsolete and is ignored across Cayenne.</I> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.sql.SQLException</CODE> |
| <DD><CODE>java.lang.Exception</CODE></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/apache/cayenne/dba/AutoAdapter.html" title="class in org.apache.cayenne.dba"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/dba/DbAdapterFactory.html" title="interface in org.apache.cayenne.dba"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/dba/DbAdapter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DbAdapter.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> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |