Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / access / translator / select / QueryAssemblerHelper.html
blob: 9bceec61b7ba0fac31edf5b68e37da25d408abd5 [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 (1.8.0_112) on Mon Oct 14 11:36:10 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>QueryAssemblerHelper (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-14">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueryAssemblerHelper (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/QueryAssemblerHelper.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/translator/select/QueryAssembler.AddBindingListener.html" title="interface in org.apache.cayenne.access.translator.select"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/cayenne/access/translator/select/SelectTranslator.html" title="interface in org.apache.cayenne.access.translator.select"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html" target="_top">Frames</a></li>
<li><a href="QueryAssemblerHelper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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.translator.select</div>
<h2 title="Class QueryAssemblerHelper" class="title">Class QueryAssemblerHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/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>org.apache.cayenne.access.translator.select.QueryAssemblerHelper</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/access/translator/select/OrderingTranslator.html" title="class in org.apache.cayenne.access.translator.select">OrderingTranslator</a>, <a href="../../../../../../org/apache/cayenne/access/translator/select/QualifierTranslator.html" title="class in org.apache.cayenne.access.translator.select">QualifierTranslator</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">QueryAssemblerHelper</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Translates parts of the query to SQL. Always works in the context of parent
Translator.</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="memberSummary" 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 <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#out">out</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssembler.html" title="class in org.apache.cayenne.access.translator.select">QueryAssembler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#queryAssembler">queryAssembler</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/cayenne/dba/QuotingStrategy.html" title="interface in org.apache.cayenne.dba">QuotingStrategy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#strategy">strategy</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#QueryAssemblerHelper-org.apache.cayenne.access.translator.select.QueryAssembler-">QueryAssemblerHelper</a></span>(<a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssembler.html" title="class in org.apache.cayenne.access.translator.select">QueryAssembler</a>&nbsp;queryAssembler)</code>
<div class="block">Creates QueryAssemblerHelper initializing with parent
<a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssembler.html" title="class in org.apache.cayenne.access.translator.select"><code>QueryAssembler</code></a> and output buffer object.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#appendDbPath-org.apache.cayenne.exp.Expression-">appendDbPath</a></span>(<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;pathExp)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#appendLikeEscapeCharacter-org.apache.cayenne.exp.parser.PatternMatchNode-">appendLikeEscapeCharacter</a></span>(<a href="../../../../../../org/apache/cayenne/exp/parser/PatternMatchNode.html" title="class in org.apache.cayenne.exp.parser">PatternMatchNode</a>&nbsp;patternMatchNode)</code>
<div class="block">
Outputs the standard JDBC (database agnostic) expression for supplying
the escape character to the database server when supplying a LIKE clause.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#appendLiteral-java.lang.Object-org.apache.cayenne.map.DbAttribute-org.apache.cayenne.exp.Expression-">appendLiteral</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val,
<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;attr,
<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;parentExpression)</code>
<div class="block">Appends SQL code to the query buffer to handle <code>val</code> as a
parameter to the PreparedStatement being built.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#appendLiteralDirect-java.lang.Object-org.apache.cayenne.map.DbAttribute-org.apache.cayenne.exp.Expression-">appendLiteralDirect</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val,
<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;attr,
<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;parentExpression)</code>
<div class="block">Appends SQL code to the query buffer to handle <code>val</code> as a
parameter to the PreparedStatement being built.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#appendObjPath-org.apache.cayenne.exp.Expression-">appendObjPath</a></span>(<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;pathExp)</code>
<div class="block">Processes parts of the OBJ_PATH expression.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#appendPart-java.lang.StringBuilder-">appendPart</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;out)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#doAppendPart--">doAppendPart</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#getDbEntity--">getDbEntity</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#getObjEntity--">getObjEntity</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#paramsDbType-org.apache.cayenne.exp.Expression-">paramsDbType</a></span>(<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;e)</code>
<div class="block">Returns database type of expression parameters or null if it can not be
determined.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#processColumn-org.apache.cayenne.map.DbAttribute-">processColumn</a></span>(<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;dbAttr)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#processColumnWithQuoteSqlIdentifiers-org.apache.cayenne.map.DbAttribute-org.apache.cayenne.exp.Expression-">processColumnWithQuoteSqlIdentifiers</a></span>(<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;dbAttr,
<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;pathExp)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#processRelTermination-org.apache.cayenne.map.DbRelationship-org.apache.cayenne.map.JoinType-java.lang.String-">processRelTermination</a></span>(<a href="../../../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>&nbsp;rel,
<a href="../../../../../../org/apache/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a>&nbsp;joinType,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;joinSplitAlias)</code>
<div class="block">Handles case when a DB_NAME expression ends with relationship.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#processRelTermination-org.apache.cayenne.map.ObjRelationship-org.apache.cayenne.map.JoinType-java.lang.String-">processRelTermination</a></span>(<a href="../../../../../../org/apache/cayenne/map/ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>&nbsp;rel,
<a href="../../../../../../org/apache/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a>&nbsp;joinType,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;joinSplitAlias)</code>
<div class="block">Processes case when an OBJ_PATH expression ends with relationship.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html#setForceJoinForRelations-boolean-">setForceJoinForRelations</a></span>(boolean&nbsp;forceJoinForRelations)</code>
<div class="block">Force joining tables for all relations, not only for toMany</div>
</td>
</tr>
</table>
<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="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="queryAssembler">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryAssembler</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssembler.html" title="class in org.apache.cayenne.access.translator.select">QueryAssembler</a> queryAssembler</pre>
</li>
</ul>
<a name="out">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>out</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> out</pre>
</li>
</ul>
<a name="strategy">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>strategy</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/cayenne/dba/QuotingStrategy.html" title="interface in org.apache.cayenne.dba">QuotingStrategy</a> strategy</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="QueryAssemblerHelper-org.apache.cayenne.access.translator.select.QueryAssembler-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>QueryAssemblerHelper</h4>
<pre>public&nbsp;QueryAssemblerHelper(<a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssembler.html" title="class in org.apache.cayenne.access.translator.select">QueryAssembler</a>&nbsp;queryAssembler)</pre>
<div class="block">Creates QueryAssemblerHelper initializing with parent
<a href="../../../../../../org/apache/cayenne/access/translator/select/QueryAssembler.html" title="class in org.apache.cayenne.access.translator.select"><code>QueryAssembler</code></a> and output buffer object.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getObjEntity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjEntity</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a>&nbsp;getObjEntity()</pre>
</li>
</ul>
<a name="getDbEntity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDbEntity</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;getDbEntity()</pre>
</li>
</ul>
<a name="appendPart-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendPart</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;appendPart(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;out)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="doAppendPart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doAppendPart</h4>
<pre>protected abstract&nbsp;void&nbsp;doAppendPart()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="appendLikeEscapeCharacter-org.apache.cayenne.exp.parser.PatternMatchNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendLikeEscapeCharacter</h4>
<pre>protected&nbsp;void&nbsp;appendLikeEscapeCharacter(<a href="../../../../../../org/apache/cayenne/exp/parser/PatternMatchNode.html" title="class in org.apache.cayenne.exp.parser">PatternMatchNode</a>&nbsp;patternMatchNode)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><p>
Outputs the standard JDBC (database agnostic) expression for supplying
the escape character to the database server when supplying a LIKE clause.
This has been factored-out because some database adaptors handle LIKE
differently and they need access to this common method in order not to
repeat this code.
<p>
If there is no escape character defined then this method will not output
anything. An escape character of 0 will mean no escape character.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a name="appendObjPath-org.apache.cayenne.exp.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendObjPath</h4>
<pre>protected&nbsp;void&nbsp;appendObjPath(<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;pathExp)</pre>
<div class="block">Processes parts of the OBJ_PATH expression.</div>
</li>
</ul>
<a name="appendDbPath-org.apache.cayenne.exp.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendDbPath</h4>
<pre>protected&nbsp;void&nbsp;appendDbPath(<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;pathExp)</pre>
</li>
</ul>
<a name="processColumn-org.apache.cayenne.map.DbAttribute-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processColumn</h4>
<pre>protected&nbsp;void&nbsp;processColumn(<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;dbAttr)</pre>
</li>
</ul>
<a name="processColumnWithQuoteSqlIdentifiers-org.apache.cayenne.map.DbAttribute-org.apache.cayenne.exp.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processColumnWithQuoteSqlIdentifiers</h4>
<pre>protected&nbsp;void&nbsp;processColumnWithQuoteSqlIdentifiers(<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;dbAttr,
<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;pathExp)</pre>
</li>
</ul>
<a name="appendLiteral-java.lang.Object-org.apache.cayenne.map.DbAttribute-org.apache.cayenne.exp.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendLiteral</h4>
<pre>protected&nbsp;void&nbsp;appendLiteral(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val,
<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;attr,
<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;parentExpression)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Appends SQL code to the query buffer to handle <code>val</code> as a
parameter to the PreparedStatement being built. Adds <code>val</code>
into QueryAssembler parameter list.
<p>
If <code>val</code> is null, "NULL" is appended to the query.
</p>
<p>
If <code>val</code> is a DataObject, its primary key value is used as a
parameter. <i>Only objects with a single column primary key can be
used.</i></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>val</code> - object that should be appended as a literal to the query. Must
be of one of "standard JDBC" types, null or a DataObject.</dd>
<dd><code>attr</code> - DbAttribute that has information on what type of parameter is
being appended.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="appendLiteralDirect-java.lang.Object-org.apache.cayenne.map.DbAttribute-org.apache.cayenne.exp.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendLiteralDirect</h4>
<pre>protected&nbsp;void&nbsp;appendLiteralDirect(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val,
<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;attr,
<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;parentExpression)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Appends SQL code to the query buffer to handle <code>val</code> as a
parameter to the PreparedStatement being built. Adds <code>val</code>
into QueryAssembler parameter list.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="paramsDbType-org.apache.cayenne.exp.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paramsDbType</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;paramsDbType(<a href="../../../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;e)</pre>
<div class="block">Returns database type of expression parameters or null if it can not be
determined.</div>
</li>
</ul>
<a name="processRelTermination-org.apache.cayenne.map.ObjRelationship-org.apache.cayenne.map.JoinType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processRelTermination</h4>
<pre>protected&nbsp;void&nbsp;processRelTermination(<a href="../../../../../../org/apache/cayenne/map/ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>&nbsp;rel,
<a href="../../../../../../org/apache/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a>&nbsp;joinType,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;joinSplitAlias)</pre>
<div class="block">Processes case when an OBJ_PATH expression ends with relationship. If
this is a "to many" relationship, a join is added and a column expression
for the target entity primary key. If this is a "to one" relationship,
column expression for the source foreign key is added.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="processRelTermination-org.apache.cayenne.map.DbRelationship-org.apache.cayenne.map.JoinType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processRelTermination</h4>
<pre>protected&nbsp;void&nbsp;processRelTermination(<a href="../../../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>&nbsp;rel,
<a href="../../../../../../org/apache/cayenne/map/JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a>&nbsp;joinType,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;joinSplitAlias)</pre>
<div class="block">Handles case when a DB_NAME expression ends with relationship. If this is
a "to many" relationship, a join is added and a column expression for the
target entity primary key. If this is a "to one" relationship, column
expression for the source foreign key is added.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="setForceJoinForRelations-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setForceJoinForRelations</h4>
<pre>protected&nbsp;void&nbsp;setForceJoinForRelations(boolean&nbsp;forceJoinForRelations)</pre>
<div class="block">Force joining tables for all relations, not only for toMany</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/QueryAssemblerHelper.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/translator/select/QueryAssembler.AddBindingListener.html" title="interface in org.apache.cayenne.access.translator.select"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/cayenne/access/translator/select/SelectTranslator.html" title="interface in org.apache.cayenne.access.translator.select"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cayenne/access/translator/select/QueryAssemblerHelper.html" target="_top">Frames</a></li>
<li><a href="QueryAssemblerHelper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>