| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_67) on Sat Sep 20 17:23:00 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>org.apache.cayenne.access.jdbc (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.cayenne.access.jdbc (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/cayenne/access/event/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/cayenne/access/trans/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cayenne/access/jdbc/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.cayenne.access.jdbc</h1> |
| <div class="docSummary"> |
| <div class="block">Contains classes that handle JDBC interactions.</div> |
| </div> |
| <p>See: <a href="#package_description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BatchQueryBuilderFactory.html" title="interface in org.apache.cayenne.access.jdbc">BatchQueryBuilderFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory which creates BatchQueryBuilders for different types of queries, which, in |
| their turn, create SQL strings for batch queries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLTranslatorFactory.html" title="interface in org.apache.cayenne.access.jdbc">EJBQLTranslatorFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a factory for translation visitors of EJBQL.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html" title="class in org.apache.cayenne.access.jdbc">BaseSQLAction</a></td> |
| <td class="colLast"> |
| <div class="block">A convenience superclass for SQLAction implementations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BatchAction.html" title="class in org.apache.cayenne.access.jdbc">BatchAction</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BindDirective.html" title="class in org.apache.cayenne.access.jdbc">BindDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to create a PreparedStatement parameter text.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BindEqualDirective.html" title="class in org.apache.cayenne.access.jdbc">BindEqualDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to create a PreparedStatement parameter text |
| for "= ?".</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BindNotEqualDirective.html" title="class in org.apache.cayenne.access.jdbc">BindNotEqualDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to create a PreparedStatement parameter text for "<>?".</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BindObjectEqualDirective.html" title="class in org.apache.cayenne.access.jdbc">BindObjectEqualDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to create a set of SQL conditions to match an ObjectId of |
| an object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/BindObjectNotEqualDirective.html" title="class in org.apache.cayenne.access.jdbc">BindObjectNotEqualDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to create a set of SQL conditions to check unequality of an |
| ObjectId of an object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/ChainDirective.html" title="class in org.apache.cayenne.access.jdbc">ChainDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to conditionally join a number of <a href="../../../../../org/apache/cayenne/access/jdbc/ChunkDirective.html" title="class in org.apache.cayenne.access.jdbc"><code>chunks</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/ChunkDirective.html" title="class in org.apache.cayenne.access.jdbc">ChunkDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to describe a conditional chunk of a <a href="../../../../../org/apache/cayenne/access/jdbc/ChainDirective.html" title="class in org.apache.cayenne.access.jdbc"><code>chain</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a></td> |
| <td class="colLast"> |
| <div class="block">A descriptor of a ResultSet column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/DefaultBatchQueryBuilderFactory.html" title="class in org.apache.cayenne.access.jdbc">DefaultBatchQueryBuilderFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Default implementation of <a href="../../../../../org/apache/cayenne/access/jdbc/BatchQueryBuilderFactory.html" title="interface in org.apache.cayenne.access.jdbc"><code>BatchQueryBuilderFactory</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/DistinctResultIterator.html" title="class in org.apache.cayenne.access.jdbc">DistinctResultIterator</a></td> |
| <td class="colLast"> |
| <div class="block">A ResultIterator that does in-memory filtering of rows to return only distinct rows.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLAction.html" title="class in org.apache.cayenne.access.jdbc">EJBQLAction</a></td> |
| <td class="colLast"> |
| <div class="block">Parses an EJBQL statement, converting it to SQL.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLConditionTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLConditionTranslator</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLDbPathTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLDbPathTranslator</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLDeleteTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLDeleteTranslator</a></td> |
| <td class="colLast"> |
| <div class="block">A translator of EJBQL DELETE statements into SQL.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLFromTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLFromTranslator</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLJoinAppender.html" title="class in org.apache.cayenne.access.jdbc">EJBQLJoinAppender</a></td> |
| <td class="colLast"> |
| <div class="block">Handles appending joins to the content buffer at a marked position.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLMultiColumnOperand.html" title="class in org.apache.cayenne.access.jdbc">EJBQLMultiColumnOperand</a></td> |
| <td class="colLast"> |
| <div class="block">A holder of multi-column match condition operand.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLPathTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLPathTranslator</a></td> |
| <td class="colLast"> |
| <div class="block">A translator that walks the relationship/attribute path, appending joins to the query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLSelectColumnsTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLSelectColumnsTranslator</a></td> |
| <td class="colLast"> |
| <div class="block">Translator of the EJBQL select clause.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLSelectTranslator.html" title="class in org.apache.cayenne.access.jdbc">EJBQLSelectTranslator</a></td> |
| <td class="colLast"> |
| <div class="block">A translator of EJBQL SELECT statements into SQL.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/EJBQLTranslationContext.html" title="class in org.apache.cayenne.access.jdbc">EJBQLTranslationContext</a></td> |
| <td class="colLast"> |
| <div class="block">A context used for translating of EJBQL to SQL.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/JdbcEJBQLTranslatorFactory.html" title="class in org.apache.cayenne.access.jdbc">JdbcEJBQLTranslatorFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A default EJBQLTranslatorFactory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/JDBCResultIterator.html" title="class in org.apache.cayenne.access.jdbc">JDBCResultIterator</a></td> |
| <td class="colLast"> |
| <div class="block">A ResultIterator over the underlying JDBC ResultSet.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/LimitResultIterator.html" title="class in org.apache.cayenne.access.jdbc">LimitResultIterator</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/ParameterBinding.html" title="class in org.apache.cayenne.access.jdbc">ParameterBinding</a></td> |
| <td class="colLast"> |
| <div class="block">Describes PreparedStatement parameter binding.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/ProcedureAction.html" title="class in org.apache.cayenne.access.jdbc">ProcedureAction</a></td> |
| <td class="colLast"> |
| <div class="block">A SQLAction that runs a stored procedure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/ResultDirective.html" title="class in org.apache.cayenne.access.jdbc">ResultDirective</a></td> |
| <td class="colLast"> |
| <div class="block">A custom Velocity directive to describe a ResultSet column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/RowDescriptor.html" title="class in org.apache.cayenne.access.jdbc">RowDescriptor</a></td> |
| <td class="colLast"> |
| <div class="block">A descriptor of a result row obtained from a database.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/RowDescriptorBuilder.html" title="class in org.apache.cayenne.access.jdbc">RowDescriptorBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">A builder class that helps to assemble <a href="../../../../../org/apache/cayenne/access/jdbc/RowDescriptor.html" title="class in org.apache.cayenne.access.jdbc"><code>RowDescriptor</code></a> instances from various |
| types of inputs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html" title="class in org.apache.cayenne.access.jdbc">SelectAction</a></td> |
| <td class="colLast"> |
| <div class="block">A SQLAction that handles SelectQuery execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SoftDeleteBatchQueryBuilder.html" title="class in org.apache.cayenne.access.jdbc">SoftDeleteBatchQueryBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/cayenne/access/trans/DeleteBatchQueryBuilder.html" title="class in org.apache.cayenne.access.trans"><code>DeleteBatchQueryBuilder</code></a>, which uses 'soft' delete (runs |
| UPDATE and sets 'deleted' field to true instead-of running SQL DELETE)</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SoftDeleteQueryBuilderFactory.html" title="class in org.apache.cayenne.access.jdbc">SoftDeleteQueryBuilderFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <code>#BatchQueryBuilderFactory</code>, which uses 'soft' delete |
| (runs UPDATE and sets 'deleted' field to true instead-of running SQL DELETE)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SQLStatement.html" title="class in org.apache.cayenne.access.jdbc">SQLStatement</a></td> |
| <td class="colLast"> |
| <div class="block">A PreparedStatement descriptor containing a String of SQL and an array of parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SQLTemplateAction.html" title="class in org.apache.cayenne.access.jdbc">SQLTemplateAction</a></td> |
| <td class="colLast"> |
| <div class="block">Implements a strategy for execution of SQLTemplates.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SQLTemplateRenderingUtils.html" title="class in org.apache.cayenne.access.jdbc">SQLTemplateRenderingUtils</a></td> |
| <td class="colLast"> |
| <div class="block">Implements utility methods used inside Velocity templates |
| when rendering SQLTemplates.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/cayenne/access/jdbc/SQLTemplateResourceManager.html" title="class in org.apache.cayenne.access.jdbc">SQLTemplateResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">An implementation of the Velocity ResourceManager and ResourceLoader that |
| creates templates from in-memory Strings.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package_description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.cayenne.access.jdbc Description">Package org.apache.cayenne.access.jdbc Description</h2> |
| <div class="block"><p>Contains classes that handle JDBC interactions.</p></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/cayenne/access/event/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/cayenne/access/trans/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cayenne/access/jdbc/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
