blob: f8208b4886995cb915adc65dc852b2870b94654d [file] [log] [blame]
<!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:22:57 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SelectTranslator (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="SelectTranslator (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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SelectTranslator.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/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/access/trans/TrimmingQualifierTranslator.html" title="class in org.apache.cayenne.access.trans"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/access/trans/SelectTranslator.html" target="_top">Frames</a></li>
<li><a href="SelectTranslator.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.access.trans</div>
<h2 title="Class SelectTranslator" class="title">Class SelectTranslator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">org.apache.cayenne.access.trans.QueryAssembler</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.access.trans.SelectTranslator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/cayenne/dba/ingres/IngresSelectTranslator.html" title="class in org.apache.cayenne.dba.ingres">IngresSelectTranslator</a>, <a href="../../../../../org/apache/cayenne/dba/sqlserver/SQLServerSelectTranslator.html" title="class in org.apache.cayenne.dba.sqlserver">SQLServerSelectTranslator</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SelectTranslator</span>
extends <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></pre>
<div class="block">A builder of JDBC PreparedStatements based on Cayenne SelectQueries. Translates
SelectQuery to parameterized SQL string and wraps it in a PreparedStatement.
SelectTranslator is stateful and thread-unsafe.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#UNSUPPORTED_DISTINCT_TYPES">UNSUPPORTED_DISTINCT_TYPES</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.access.trans.QueryAssembler">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.access.trans.<a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#adapter">adapter</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#attributes">attributes</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#connection">connection</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#entityResolver">entityResolver</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#logger">logger</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#parameterIndex">parameterIndex</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#query">query</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#queryMetadata">queryMetadata</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#values">values</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#SelectTranslator()">SelectTranslator</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#appendLimitAndOffsetClauses(java.lang.StringBuilder)">appendLimitAndOffsetClauses</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buffer)</code>
<div class="block">Handles appending optional limit and offset clauses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#appendSelectColumns(java.lang.StringBuilder,%20java.util.List)">appendSelectColumns</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buffer,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;selectColumnExpList)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#buildResultColumns()">buildResultColumns</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cayenne/access/trans/JoinStack.html" title="class in org.apache.cayenne.access.trans">JoinStack</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#createJoinStack()">createJoinStack</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#createSqlString()">createSqlString</a></strong>()</code>
<div class="block">Returns query translated to SQL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#dbRelationshipAdded(org.apache.cayenne.map.DbRelationship,%20org.apache.cayenne.map.JoinType,%20java.lang.String)">dbRelationshipAdded</a></strong>(<a href="../../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>&nbsp;relationship,
<a href="../../../../../org/apache/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a>&nbsp;joinType,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;joinSplitAlias)</code>
<div class="block">Appends a join with given semantics to the query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>,<a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#getAttributeOverrides()">getAttributeOverrides</a></strong>()</code>
<div class="block">Returns a map of ColumnDescriptors keyed by ObjAttribute for columns that may need
to be reprocessed manually due to incompatible mappings along the inheritance
hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#getCurrentAlias()">getCurrentAlias</a></strong>()</code>
<div class="block">Returns an alias of the table which is currently at the top of the join stack.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/trans/JoinStack.html" title="class in org.apache.cayenne.access.trans">JoinStack</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#getJoinStack()">getJoinStack</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#getResultColumns()">getResultColumns</a></strong>()</code>
<div class="block">Returns a list of ColumnDescriptors for the query columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#isSuppressingDistinct()">isSuppressingDistinct</a></strong>()</code>
<div class="block">Returns true if SelectTranslator determined that a query requiring DISTINCT can't
be run with DISTINCT keyword for internal reasons.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#isUnsupportedForDistinct(int)">isUnsupportedForDistinct</a></strong>(int&nbsp;type)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#resetJoinStack()">resetJoinStack</a></strong>()</code>
<div class="block">A callback invoked by a child qualifier or ordering processor allowing query
assembler to reset its join stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html#supportsTableAliases()">supportsTableAliases</a></strong>()</code>
<div class="block">Always returns true.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.access.trans.QueryAssembler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.access.trans.<a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#addToParamList(org.apache.cayenne.map.DbAttribute,%20java.lang.Object)">addToParamList</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#createStatement()">createStatement</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getAdapter()">getAdapter</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getEntityResolver()">getEntityResolver</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getJdbcEventLogger()">getJdbcEventLogger</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getPathAliases()">getPathAliases</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getQuery()">getQuery</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getQueryMetadata()">getQueryMetadata</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getRootDbEntity()">getRootDbEntity</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getRootEntity()">getRootEntity</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#initStatement(java.sql.PreparedStatement)">initStatement</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#setAdapter(org.apache.cayenne.dba.DbAdapter)">setAdapter</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#setConnection(java.sql.Connection)">setConnection</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#setEntityResolver(org.apache.cayenne.map.EntityResolver)">setEntityResolver</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#setJdbcEventLogger(org.apache.cayenne.log.JdbcEventLogger)">setJdbcEventLogger</a>, <a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#setQuery(org.apache.cayenne.query.Query)">setQuery</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="UNSUPPORTED_DISTINCT_TYPES">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UNSUPPORTED_DISTINCT_TYPES</h4>
<pre>protected static final&nbsp;int[] UNSUPPORTED_DISTINCT_TYPES</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SelectTranslator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SelectTranslator</h4>
<pre>public&nbsp;SelectTranslator()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isUnsupportedForDistinct(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUnsupportedForDistinct</h4>
<pre>protected static&nbsp;boolean&nbsp;isUnsupportedForDistinct(int&nbsp;type)</pre>
</li>
</ul>
<a name="getJoinStack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoinStack</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/cayenne/access/trans/JoinStack.html" title="class in org.apache.cayenne.access.trans">JoinStack</a>&nbsp;getJoinStack()</pre>
</li>
</ul>
<a name="createJoinStack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createJoinStack</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/cayenne/access/trans/JoinStack.html" title="class in org.apache.cayenne.access.trans">JoinStack</a>&nbsp;createJoinStack()</pre>
</li>
</ul>
<a name="createSqlString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSqlString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;createSqlString()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns query translated to SQL. This is a main work method of the
SelectTranslator.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#createSqlString()">createSqlString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="appendSelectColumns(java.lang.StringBuilder, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendSelectColumns</h4>
<pre>protected&nbsp;void&nbsp;appendSelectColumns(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buffer,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;selectColumnExpList)</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
<a name="appendLimitAndOffsetClauses(java.lang.StringBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendLimitAndOffsetClauses</h4>
<pre>protected&nbsp;void&nbsp;appendLimitAndOffsetClauses(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buffer)</pre>
<div class="block">Handles appending optional limit and offset clauses. This implementation does
nothing, deferring to subclasses to define the LIMIT/OFFSET clause syntax.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="getCurrentAlias()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentAlias</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCurrentAlias()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getCurrentAlias()">QueryAssembler</a></code></strong></div>
<div class="block">Returns an alias of the table which is currently at the top of the join stack.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#getCurrentAlias()">getCurrentAlias</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></code></dd>
</dl>
</li>
</ul>
<a name="getResultColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultColumns</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;getResultColumns()</pre>
<div class="block">Returns a list of ColumnDescriptors for the query columns.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="getAttributeOverrides()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeOverrides</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>,<a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>&gt;&nbsp;getAttributeOverrides()</pre>
<div class="block">Returns a map of ColumnDescriptors keyed by ObjAttribute for columns that may need
to be reprocessed manually due to incompatible mappings along the inheritance
hierarchy.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="isSuppressingDistinct()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSuppressingDistinct</h4>
<pre>public&nbsp;boolean&nbsp;isSuppressingDistinct()</pre>
<div class="block">Returns true if SelectTranslator determined that a query requiring DISTINCT can't
be run with DISTINCT keyword for internal reasons. If this method returns true,
DataNode may need to do in-memory distinct filtering.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="buildResultColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildResultColumns</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>&gt;&nbsp;buildResultColumns()</pre>
</li>
</ul>
<a name="resetJoinStack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetJoinStack</h4>
<pre>public&nbsp;void&nbsp;resetJoinStack()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#resetJoinStack()">QueryAssembler</a></code></strong></div>
<div class="block">A callback invoked by a child qualifier or ordering processor allowing query
assembler to reset its join stack.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#resetJoinStack()">resetJoinStack</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></code></dd>
<dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="dbRelationshipAdded(org.apache.cayenne.map.DbRelationship, org.apache.cayenne.map.JoinType, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dbRelationshipAdded</h4>
<pre>public&nbsp;void&nbsp;dbRelationshipAdded(<a href="../../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>&nbsp;relationship,
<a href="../../../../../org/apache/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a>&nbsp;joinType,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;joinSplitAlias)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#dbRelationshipAdded(org.apache.cayenne.map.DbRelationship,%20org.apache.cayenne.map.JoinType,%20java.lang.String)">QueryAssembler</a></code></strong></div>
<div class="block">Appends a join with given semantics to the query.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#dbRelationshipAdded(org.apache.cayenne.map.DbRelationship,%20org.apache.cayenne.map.JoinType,%20java.lang.String)">dbRelationshipAdded</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></code></dd>
<dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="supportsTableAliases()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>supportsTableAliases</h4>
<pre>public&nbsp;boolean&nbsp;supportsTableAliases()</pre>
<div class="block">Always returns true.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html#supportsTableAliases()">supportsTableAliases</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/trans/QueryAssembler.html" title="class in org.apache.cayenne.access.trans">QueryAssembler</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SelectTranslator.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/trans/QueryAssemblerHelper.html" title="class in org.apache.cayenne.access.trans"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/access/trans/TrimmingQualifierTranslator.html" title="class in org.apache.cayenne.access.trans"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/access/trans/SelectTranslator.html" target="_top">Frames</a></li>
<li><a href="SelectTranslator.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>