blob: c8cf98d208eb9e92aed741d9039e944d31297296 [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:59 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SQLActionVisitor (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="SQLActionVisitor (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/SQLActionVisitor.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/query/SQLAction.html" title="interface in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/SQLActionVisitor.html" target="_top">Frames</a></li>
<li><a href="SQLActionVisitor.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.query</div>
<h2 title="Interface SQLActionVisitor" class="title">Interface SQLActionVisitor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cayenne/dba/db2/DB2ActionBuilder.html" title="class in org.apache.cayenne.dba.db2">DB2ActionBuilder</a>, <a href="../../../../org/apache/cayenne/dba/ingres/IngresActionBuilder.html" title="class in org.apache.cayenne.dba.ingres">IngresActionBuilder</a>, <a href="../../../../org/apache/cayenne/dba/JdbcActionBuilder.html" title="class in org.apache.cayenne.dba">JdbcActionBuilder</a>, <a href="../../../../org/apache/cayenne/dba/sqlserver/SQLServerActionBuilder.html" title="class in org.apache.cayenne.dba.sqlserver">SQLServerActionBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">SQLActionVisitor</span></pre>
<div class="block">A factory interface to create standard SQLActions for a set of standard queries.
Instances of SQLActionVisitor are passed by Cayenne to a Query in
<a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"><code>Query.createSQLAction(SQLActionVisitor)</code></a>, allowing
query to choose the action type and convert itself to a "standard" query if needed.
Individual DbAdapters would provide special visitors, thus allowing for DB-dependent
execution algorithms.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"><code>Query.createSQLAction(SQLActionVisitor)</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html#batchAction(org.apache.cayenne.query.BatchQuery)">batchAction</a></strong>(<a href="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</a>&nbsp;query)</code>
<div class="block">Creates an action to execute a batch update query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html#ejbqlAction(org.apache.cayenne.query.EJBQLQuery)">ejbqlAction</a></strong>(<a href="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</a>&nbsp;query)</code>
<div class="block">Creates an action to execute EJBQL query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html#objectSelectAction(org.apache.cayenne.query.SelectQuery)">objectSelectAction</a></strong>(<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>&nbsp;query)</code>
<div class="block">Creates an action to execute a SelectQuery.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html#procedureAction(org.apache.cayenne.query.ProcedureQuery)">procedureAction</a></strong>(<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</a>&nbsp;query)</code>
<div class="block">Creates an action to execute a ProcedureQuery.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html#sqlAction(org.apache.cayenne.query.SQLTemplate)">sqlAction</a></strong>(<a href="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</a>&nbsp;query)</code>
<div class="block">Creates an action to execute a SQLTemplate.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="batchAction(org.apache.cayenne.query.BatchQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchAction</h4>
<pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;batchAction(<a href="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</a>&nbsp;query)</pre>
<div class="block">Creates an action to execute a batch update query.</div>
</li>
</ul>
<a name="objectSelectAction(org.apache.cayenne.query.SelectQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>objectSelectAction</h4>
<pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;objectSelectAction(<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>&nbsp;query)</pre>
<div class="block">Creates an action to execute a SelectQuery.</div>
</li>
</ul>
<a name="sqlAction(org.apache.cayenne.query.SQLTemplate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sqlAction</h4>
<pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;sqlAction(<a href="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</a>&nbsp;query)</pre>
<div class="block">Creates an action to execute a SQLTemplate.</div>
</li>
</ul>
<a name="procedureAction(org.apache.cayenne.query.ProcedureQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>procedureAction</h4>
<pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;procedureAction(<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</a>&nbsp;query)</pre>
<div class="block">Creates an action to execute a ProcedureQuery.</div>
</li>
</ul>
<a name="ejbqlAction(org.apache.cayenne.query.EJBQLQuery)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ejbqlAction</h4>
<pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;ejbqlAction(<a href="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</a>&nbsp;query)</pre>
<div class="block">Creates an action to execute EJBQL query.</div>
</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/SQLActionVisitor.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/query/SQLAction.html" title="interface in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/SQLActionVisitor.html" target="_top">Frames</a></li>
<li><a href="SQLActionVisitor.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>