Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.0 / api / org / apache / cayenne / query / SQLActionVisitor.html
blob: d30336df7e7971542bc24156579f997810b3880e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Sat Jun 11 11:32:59 EEST 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
SQLActionVisitor (Cayenne Documentation 3.0.2 API)
</TITLE>
<META NAME="date" CONTENT="2011-06-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SQLActionVisitor (Cayenne Documentation 3.0.2 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SQLActionVisitor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/query/SQLActionVisitor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SQLActionVisitor.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.cayenne.query</FONT>
<BR>
Interface SQLActionVisitor</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><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>
<DL>
<DT><PRE>public interface <B>SQLActionVisitor</B></DL>
</PRE>
<P>
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.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"><CODE>Query.createSQLAction(SQLActionVisitor)</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html#batchAction(org.apache.cayenne.query.BatchQuery)">batchAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an action to execute a batch update query.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html#ejbqlAction(org.apache.cayenne.query.EJBQLQuery)">ejbqlAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an action to execute EJBQL query.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html#objectSelectAction(org.apache.cayenne.query.SelectQuery)">objectSelectAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an action to execute a SelectQuery.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html#procedureAction(org.apache.cayenne.query.ProcedureQuery)">procedureAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an action to execute a ProcedureQuery.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html#sqlAction(org.apache.cayenne.query.SQLTemplate)">sqlAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an action to execute a SQLTemplate.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html#updateAction(org.apache.cayenne.query.Query)">updateAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>since 3.0 as the corresponding <A HREF="../../../../org/apache/cayenne/query/UpdateQuery.html" title="class in org.apache.cayenne.query"><CODE>UpdateQuery</CODE></A> and
<A HREF="../../../../org/apache/cayenne/query/DeleteQuery.html" title="class in org.apache.cayenne.query"><CODE>DeleteQuery</CODE></A> queries are deprecated.</I></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="updateAction(org.apache.cayenne.query.Query)"><!-- --></A><H3>
updateAction</H3>
<PRE>
<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>updateAction</B>(<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>&nbsp;query)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>since 3.0 as the corresponding <A HREF="../../../../org/apache/cayenne/query/UpdateQuery.html" title="class in org.apache.cayenne.query"><CODE>UpdateQuery</CODE></A> and
<A HREF="../../../../org/apache/cayenne/query/DeleteQuery.html" title="class in org.apache.cayenne.query"><CODE>DeleteQuery</CODE></A> queries are deprecated.</I>
<P>
<DD>Creates an action to execute a generic update query.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="batchAction(org.apache.cayenne.query.BatchQuery)"><!-- --></A><H3>
batchAction</H3>
<PRE>
<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>batchAction</B>(<A HREF="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</A>&nbsp;query)</PRE>
<DL>
<DD>Creates an action to execute a batch update query.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="objectSelectAction(org.apache.cayenne.query.SelectQuery)"><!-- --></A><H3>
objectSelectAction</H3>
<PRE>
<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>objectSelectAction</B>(<A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A>&nbsp;query)</PRE>
<DL>
<DD>Creates an action to execute a SelectQuery.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="sqlAction(org.apache.cayenne.query.SQLTemplate)"><!-- --></A><H3>
sqlAction</H3>
<PRE>
<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>sqlAction</B>(<A HREF="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</A>&nbsp;query)</PRE>
<DL>
<DD>Creates an action to execute a SQLTemplate.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="procedureAction(org.apache.cayenne.query.ProcedureQuery)"><!-- --></A><H3>
procedureAction</H3>
<PRE>
<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>procedureAction</B>(<A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</A>&nbsp;query)</PRE>
<DL>
<DD>Creates an action to execute a ProcedureQuery.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="ejbqlAction(org.apache.cayenne.query.EJBQLQuery)"><!-- --></A><H3>
ejbqlAction</H3>
<PRE>
<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>ejbqlAction</B>(<A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</A>&nbsp;query)</PRE>
<DL>
<DD>Creates an action to execute EJBQL query.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SQLActionVisitor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/query/SQLActionVisitor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SQLActionVisitor.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2001-2011 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All Rights Reserved.
</BODY>
</HTML>