| <!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> |
| EJBQLQuery (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="EJBQLQuery (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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EJBQLQuery.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/cayenne/query/DeleteQuery.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/EntityResultSegment.html" title="interface 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/EJBQLQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="EJBQLQuery.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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> |
| Class EJBQLQuery</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.query.EJBQLQuery</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>, <A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>EJBQLQuery</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>, <A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></DL> |
| </PRE> |
| |
| <P> |
| An EJBQL query representation in Cayenne. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.cayenne.query.EJBQLQuery">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#ejbqlStatement">ejbqlStatement</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/cayenne/ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#expression">expression</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#name">name</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#namedParameters">namedParameters</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#positionalParameters">positionalParameters</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#EJBQLQuery()">EJBQLQuery</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#EJBQLQuery(java.lang.String)">EJBQLQuery</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> ejbqlStatement)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> <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/EJBQLQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</A> visitor)</CODE> |
| |
| <BR> |
| A callback method invoked by Cayenne during the final execution phase of the query |
| run.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A> encoder)</CODE> |
| |
| <BR> |
| Prints itself as XML to the provided XMLEncoder.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getCacheGroups()">getCacheGroups</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getCacheStrategy()">getCacheStrategy</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getEjbqlStatement()">getEjbqlStatement</A></B>()</CODE> |
| |
| <BR> |
| Returns an unparsed EJB QL statement used to initialize this query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getExpression(org.apache.cayenne.map.EntityResolver)">getExpression</A></B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver)</CODE> |
| |
| <BR> |
| Returns lazily initialized EJBQLCompiledExpression for this query EJBQL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getFetchLimit()">getFetchLimit</A></B>()</CODE> |
| |
| <BR> |
| Returns the fetchLimit property indicating the maximum number of rows this query |
| would return.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getFetchOffset()">getFetchOffset</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</A></B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver)</CODE> |
| |
| <BR> |
| Returns query runtime parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Returns a symbolic name of the query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getNamedParameters()">getNamedParameters</A></B>()</CODE> |
| |
| <BR> |
| Returns unmodifiable map of combined named and positional parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getPageSize()">getPageSize</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getPositionalParameters()">getPositionalParameters</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#getStatementFetchSize()">getStatementFetchSize</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#initWithProperties(java.util.Map)">initWithProperties</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,?> properties)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#isFetchingDataRows()">isFetchingDataRows</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">route</A></B>(<A HREF="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</A> router, |
| <A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> substitutedQuery)</CODE> |
| |
| <BR> |
| A callback method invoked by Cayenne during the routing phase of the query |
| execution.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setCacheGroups(java.lang.String...)">setCacheGroups</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... cacheGroups)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)">setCacheStrategy</A></B>(<A HREF="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</A> strategy)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setEjbqlStatement(java.lang.String)">setEjbqlStatement</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> text)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setFetchingDataRows(boolean)">setFetchingDataRows</A></B>(boolean flag)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setFetchLimit(int)">setFetchLimit</A></B>(int fetchLimit)</CODE> |
| |
| <BR> |
| Sets the fetchLimit property indicating the maximum number of rows this query would |
| return.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setFetchOffset(int)">setFetchOffset</A></B>(int fetchOffset)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setPageSize(int)">setPageSize</A></B>(int pageSize)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setParameter(int, java.lang.Object)">setParameter</A></B>(int position, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</CODE> |
| |
| <BR> |
| Sets a positional query parameter value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setParameter(java.lang.String, java.lang.Object)">setParameter</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</CODE> |
| |
| <BR> |
| Sets a named query parameter value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html#setStatementFetchSize(int)">setStatementFetchSize</A></B>(int size)</CODE> |
| |
| <BR> |
| Sets statement's fetch size (0 for no default size)</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/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://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="name"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>name</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ejbqlStatement"><!-- --></A><H3> |
| ejbqlStatement</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ejbqlStatement</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="namedParameters"><!-- --></A><H3> |
| namedParameters</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>> <B>namedParameters</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="positionalParameters"><!-- --></A><H3> |
| positionalParameters</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>> <B>positionalParameters</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="expression"><!-- --></A><H3> |
| expression</H3> |
| <PRE> |
| protected transient <A HREF="../../../../org/apache/cayenne/ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</A> <B>expression</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="EJBQLQuery(java.lang.String)"><!-- --></A><H3> |
| EJBQLQuery</H3> |
| <PRE> |
| public <B>EJBQLQuery</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> ejbqlStatement)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EJBQLQuery()"><!-- --></A><H3> |
| EJBQLQuery</H3> |
| <PRE> |
| public <B>EJBQLQuery</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ 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="initWithProperties(java.util.Map)"><!-- --></A><H3> |
| initWithProperties</H3> |
| <PRE> |
| public void <B>initWithProperties</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,?> properties)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMetaData(org.apache.cayenne.map.EntityResolver)"><!-- --></A><H3> |
| getMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</A> <B>getMetaData</B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">Query</A></CODE></B></DD> |
| <DD>Returns query runtime parameters. The method is called at various stages of the |
| execution by Cayenne access stack to retrieve query parameters. EntityResolver |
| instance is passed to this method, meaning that the query doesn't need to store |
| direct references to Cayenne mapping objects and can resolve them at runtime. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFetchingDataRows()"><!-- --></A><H3> |
| isFetchingDataRows</H3> |
| <PRE> |
| public boolean <B>isFetchingDataRows</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchingDataRows(boolean)"><!-- --></A><H3> |
| setFetchingDataRows</H3> |
| <PRE> |
| public void <B>setFetchingDataRows</B>(boolean flag)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCacheGroups()"><!-- --></A><H3> |
| getCacheGroups</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>getCacheGroups</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCacheStrategy()"><!-- --></A><H3> |
| getCacheStrategy</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</A> <B>getCacheStrategy</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCacheGroups(java.lang.String...)"><!-- --></A><H3> |
| setCacheGroups</H3> |
| <PRE> |
| public void <B>setCacheGroups</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... cacheGroups)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)"><!-- --></A><H3> |
| setCacheStrategy</H3> |
| <PRE> |
| public void <B>setCacheStrategy</B>(<A HREF="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</A> strategy)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)"><!-- --></A><H3> |
| route</H3> |
| <PRE> |
| public void <B>route</B>(<A HREF="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</A> router, |
| <A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> substitutedQuery)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">Query</A></CODE></B></DD> |
| <DD>A callback method invoked by Cayenne during the routing phase of the query |
| execution. Mapping of DataNodes is provided by QueryRouter. Query should use a |
| <A HREF="../../../../org/apache/cayenne/query/QueryRouter.html#route(org.apache.cayenne.access.QueryEngine, org.apache.cayenne.query.Query, org.apache.cayenne.query.Query)"><CODE>QueryRouter.route(QueryEngine, Query, Query)</CODE></A> callback method to route |
| itself. Query can create one or more substitute queries or even provide its own |
| QueryEngine to execute itself. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">route</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"><!-- --></A><H3> |
| createSQLAction</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>createSQLAction</B>(<A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</A> visitor)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">Query</A></CODE></B></DD> |
| <DD>A callback method invoked by Cayenne during the final execution phase of the query |
| run. A concrete query implementation is given a chance to decide how it should be |
| handled. Implementors can pick an appropriate method of the SQLActionVisitor to |
| handle itself, create a custom SQLAction of its own, or substitute itself with |
| another query that should be used for SQLAction construction. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEjbqlStatement()"><!-- --></A><H3> |
| getEjbqlStatement</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getEjbqlStatement</B>()</PRE> |
| <DL> |
| <DD>Returns an unparsed EJB QL statement used to initialize this query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExpression(org.apache.cayenne.map.EntityResolver)"><!-- --></A><H3> |
| getExpression</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</A> <B>getExpression</B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver) |
| throws <A HREF="../../../../org/apache/cayenne/ejbql/EJBQLException.html" title="class in org.apache.cayenne.ejbql">EJBQLException</A></PRE> |
| <DL> |
| <DD>Returns lazily initialized EJBQLCompiledExpression for this query EJBQL. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/ejbql/EJBQLException.html" title="class in org.apache.cayenne.ejbql">EJBQLException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getName()">Query</A></CODE></B></DD> |
| <DD>Returns a symbolic name of the query. The name may be used as a key to find queries |
| stored in the DataMap. Some query implementors reuse the name as a QueryMetadata |
| cache key. Generally the name can be null. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| public void <B>setName</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNamedParameters()"><!-- --></A><H3> |
| getNamedParameters</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>> <B>getNamedParameters</B>()</PRE> |
| <DL> |
| <DD>Returns unmodifiable map of combined named and positional parameters. Positional |
| parameter keys are Integers, while named parameter keys are strings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPositionalParameters()"><!-- --></A><H3> |
| getPositionalParameters</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>> <B>getPositionalParameters</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setParameter(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| setParameter</H3> |
| <PRE> |
| public void <B>setParameter</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</PRE> |
| <DL> |
| <DD>Sets a named query parameter value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setParameter(int, java.lang.Object)"><!-- --></A><H3> |
| setParameter</H3> |
| <PRE> |
| public void <B>setParameter</B>(int position, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</PRE> |
| <DL> |
| <DD>Sets a positional query parameter value. Note that parameter indexes are starting |
| from 1. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFetchLimit()"><!-- --></A><H3> |
| getFetchLimit</H3> |
| <PRE> |
| public int <B>getFetchLimit</B>()</PRE> |
| <DL> |
| <DD>Returns the fetchLimit property indicating the maximum number of rows this query |
| would return. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchLimit(int)"><!-- --></A><H3> |
| setFetchLimit</H3> |
| <PRE> |
| public void <B>setFetchLimit</B>(int fetchLimit)</PRE> |
| <DL> |
| <DD>Sets the fetchLimit property indicating the maximum number of rows this query would |
| return. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFetchOffset()"><!-- --></A><H3> |
| getFetchOffset</H3> |
| <PRE> |
| public int <B>getFetchOffset</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchOffset(int)"><!-- --></A><H3> |
| setFetchOffset</H3> |
| <PRE> |
| public void <B>setFetchOffset</B>(int fetchOffset)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="encodeAsXML(org.apache.cayenne.util.XMLEncoder)"><!-- --></A><H3> |
| encodeAsXML</H3> |
| <PRE> |
| public void <B>encodeAsXML</B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A> encoder)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">XMLSerializable</A></CODE></B></DD> |
| <DD>Prints itself as XML to the provided XMLEncoder. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setEjbqlStatement(java.lang.String)"><!-- --></A><H3> |
| setEjbqlStatement</H3> |
| <PRE> |
| public void <B>setEjbqlStatement</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> text)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPageSize()"><!-- --></A><H3> |
| getPageSize</H3> |
| <PRE> |
| public int <B>getPageSize</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPageSize(int)"><!-- --></A><H3> |
| setPageSize</H3> |
| <PRE> |
| public void <B>setPageSize</B>(int pageSize)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStatementFetchSize(int)"><!-- --></A><H3> |
| setStatementFetchSize</H3> |
| <PRE> |
| public void <B>setStatementFetchSize</B>(int size)</PRE> |
| <DL> |
| <DD>Sets statement's fetch size (0 for no default size) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStatementFetchSize()"><!-- --></A><H3> |
| getStatementFetchSize</H3> |
| <PRE> |
| public int <B>getStatementFetchSize</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>statement's fetch size<DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EJBQLQuery.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/cayenne/query/DeleteQuery.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/EntityResultSegment.html" title="interface 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/EJBQLQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="EJBQLQuery.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2001-2011 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
