| <!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.5.0_06) on Wed Jul 19 14:45:52 EDT 2006 --> |
| <TITLE> |
| ProcedureQuery (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.query.ProcedureQuery class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ProcedureQuery (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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="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-files/index-1.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/PrefetchTreeNode.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.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/ProcedureQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ProcedureQuery.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 ProcedureQuery</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.query.ProcedureQuery</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A>, <A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</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>ProcedureQuery</B><DT>extends <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A><DT>implements <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A>, <A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</A>, <A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></DL> |
| </PRE> |
| |
| <P> |
| A query based on Procedure. Can be used as a select query, or as a query of an |
| arbitrary complexity, performing data modification, selecting data (possibly with |
| multiple result sets per call), returning values via OUT parameters. |
| <h3>Execution with DataContext</h3> |
| <h4>Reading OUT parameters</h4> |
| <p> |
| If a ProcedureQuery has OUT parameters, they are wrapped in a separate List in the |
| query result. Such list will contain a single Map with OUT parameter values. |
| </p> |
| <h4>Using ProcedureQuery as a GenericSelectQuery</h4> |
| <p> |
| Executing ProcedureQuery via |
| <A HREF="../../../../org/apache/cayenne/access/DataContext.html#performQuery(org.apache.cayenne.query.Query)"><CODE>DataContext.performQuery(Query)</CODE></A> makes sense only |
| if the stored procedure returns a single result set (or alternatively returns a result |
| via OUT parameters and no other result sets). It is still OK if data modification |
| occurs as a side effect. However if the query returns more then one result set, a more |
| generic form should be used: |
| <A HREF="../../../../org/apache/cayenne/access/DataContext.html#performGenericQuery(org.apache.cayenne.query.Query)"><CODE>DataContext.performGenericQuery(Query)</CODE></A>. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrus Adamchik</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.cayenne.query.ProcedureQuery">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 java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#parameters">parameters</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.Class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultClass">resultClass</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultClassName">resultClassName</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 'resultEntityName' must be used.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultDescriptors">resultDescriptors</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultEntityName">resultEntityName</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#selecting">selecting</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 as this information is no longer relavant to Cayenne</I></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.query.AbstractQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#name">name</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#root">root</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.query.GenericSelectQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from interface org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#CACHE_POLICY_DEFAULT">CACHE_POLICY_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#CACHE_POLICY_PROPERTY">CACHE_POLICY_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCH_LIMIT_DEFAULT">FETCH_LIMIT_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCH_LIMIT_PROPERTY">FETCH_LIMIT_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCHING_DATA_ROWS_DEFAULT">FETCHING_DATA_ROWS_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCHING_DATA_ROWS_PROPERTY">FETCHING_DATA_ROWS_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#LOCAL_CACHE">LOCAL_CACHE</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#NO_CACHE">NO_CACHE</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#PAGE_SIZE_DEFAULT">PAGE_SIZE_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#PAGE_SIZE_PROPERTY">PAGE_SIZE_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#REFRESHING_OBJECTS_DEFAULT">REFRESHING_OBJECTS_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#REFRESHING_OBJECTS_PROPERTY">REFRESHING_OBJECTS_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#RESOLVING_INHERITED_DEFAULT">RESOLVING_INHERITED_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#RESOLVING_INHERITED_PROPERTY">RESOLVING_INHERITED_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#SHARED_CACHE">SHARED_CACHE</A></CODE></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/ProcedureQuery.html#ProcedureQuery()">ProcedureQuery</A></B>()</CODE> |
| |
| <BR> |
| Creates an empty procedure query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(org.apache.cayenne.map.Procedure)">ProcedureQuery</A></B>(<A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A> procedure)</CODE> |
| |
| <BR> |
| Creates a ProcedureQuery based on a Procedure object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(org.apache.cayenne.map.Procedure, java.lang.Class)">ProcedureQuery</A></B>(<A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A> procedure, |
| java.lang.Class resultType)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String)">ProcedureQuery</A></B>(java.lang.String procedureName)</CODE> |
| |
| <BR> |
| Creates a ProcedureQuery based on a stored procedure.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String, java.lang.Class)">ProcedureQuery</A></B>(java.lang.String procedureName, |
| java.lang.Class resultType)</CODE> |
| |
| <BR> |
| |
| Performance Note: with current EntityResolver implementation it is preferrable to |
| use Procedure object instead of String as a query root.</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#addParameter(java.lang.String, java.lang.Object)">addParameter</A></B>(java.lang.String name, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| Adds a named parameter to the internal map of parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#addPrefetch(java.lang.String)">addPrefetch</A></B>(java.lang.String prefetchPath)</CODE> |
| |
| <BR> |
| Adds a prefetch.</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/ProcedureQuery.html#addPrefetches(java.util.Collection)">addPrefetches</A></B>(java.util.Collection prefetches)</CODE> |
| |
| <BR> |
| Adds all prefetches from a provided collection.</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/ProcedureQuery.html#addResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])">addResultDescriptor</A></B>(<A HREF="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</A>[] descriptor)</CODE> |
| |
| <BR> |
| Adds a descriptor for a single ResultSet.</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/ProcedureQuery.html#clearParameters()">clearParameters</A></B>()</CODE> |
| |
| <BR> |
| Cleans up all configured parameters.</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/ProcedureQuery.html#clearPrefetches()">clearPrefetches</A></B>()</CODE> |
| |
| <BR> |
| Clears all prefetches.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#createQuery(java.util.Map)">createQuery</A></B>(java.util.Map parameters)</CODE> |
| |
| <BR> |
| Creates and returns a new ProcedureQuery built using this query as a prototype and |
| substituting template parameters with the values from the map.</TD> |
| </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/ProcedureQuery.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> |
| Calls "makeProcedure" on the visitor.</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/ProcedureQuery.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 PrintWriter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getCachePolicy()">getCachePolicy</A></B>()</CODE> |
| |
| <BR> |
| Returns query cache policy, which can be one of <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#NO_CACHE"><CODE>GenericSelectQuery.NO_CACHE</CODE></A>, |
| <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#LOCAL_CACHE"><CODE>GenericSelectQuery.LOCAL_CACHE</CODE></A>, or <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#SHARED_CACHE"><CODE>GenericSelectQuery.SHARED_CACHE</CODE></A>.</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/ProcedureQuery.html#getFetchLimit()">getFetchLimit</A></B>()</CODE> |
| |
| <BR> |
| Returns the limit on the maximium number of records that can be returned by 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/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.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 default select 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/ProcedureQuery.html#getPageSize()">getPageSize</A></B>()</CODE> |
| |
| <BR> |
| Returns query page size.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getParameters()">getParameters</A></B>()</CODE> |
| |
| <BR> |
| Returns a map of procedure parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getPrefetchTree()">getPrefetchTree</A></B>()</CODE> |
| |
| <BR> |
| Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultClass(java.lang.ClassLoader)">getResultClass</A></B>(java.lang.ClassLoader classLoader)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultClassName()">getResultClassName</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 use <A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultEntityName()"><CODE>getResultEntityName()</CODE></A></I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultDescriptors()">getResultDescriptors</A></B>()</CODE> |
| |
| <BR> |
| Returns a List of #<A HREF="../../../../org/apache/cayenne/access/jdbc/RowDescriptor.html" title="class in org.apache.cayenne.access.jdbc"><CODE>RowDescriptor</CODE></A> objects describing query ResultSets in |
| the order they are returned by the stored procedure.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultEntityName()">getResultEntityName</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/ProcedureQuery.html#initWithProperties(java.util.Map)">initWithProperties</A></B>(java.util.Map properties)</CODE> |
| |
| <BR> |
| Initializes query parameters using a set of properties.</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/ProcedureQuery.html#isFetchingDataRows()">isFetchingDataRows</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects.</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/ProcedureQuery.html#isRefreshingObjects()">isRefreshingObjects</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the query results should replace any currently |
| cached values, returns <code>false</code> otherwise.</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/ProcedureQuery.html#isResolvingInherited()">isResolvingInherited</A></B>()</CODE> |
| |
| <BR> |
| Returns true if objects fetched via this query should be fully resolved according |
| to the inheritance hierarchy.</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/ProcedureQuery.html#isSelecting()">isSelecting</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 as this information is no longer relavant to Cayenne</I></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/ProcedureQuery.html#removeParameter(java.lang.String)">removeParameter</A></B>(java.lang.String 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/ProcedureQuery.html#removePrefetch(java.lang.String)">removePrefetch</A></B>(java.lang.String prefetch)</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/ProcedureQuery.html#removeResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])">removeResultDescriptor</A></B>(<A HREF="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</A>[] descriptor)</CODE> |
| |
| <BR> |
| Removes result descriptor from the list of descriptors.</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/ProcedureQuery.html#setCachePolicy(java.lang.String)">setCachePolicy</A></B>(java.lang.String policy)</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/ProcedureQuery.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/ProcedureQuery.html#setFetchLimit(int)">setFetchLimit</A></B>(int fetchLimit)</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/ProcedureQuery.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/ProcedureQuery.html#setParameters(java.util.Map)">setParameters</A></B>(java.util.Map parameters)</CODE> |
| |
| <BR> |
| Sets a map of parameters.</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/ProcedureQuery.html#setRefreshingObjects(boolean)">setRefreshingObjects</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/ProcedureQuery.html#setResolvingInherited(boolean)">setResolvingInherited</A></B>(boolean 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/ProcedureQuery.html#setResultClassName(java.lang.String)">setResultClassName</A></B>(java.lang.String resultClassName)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 use <A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName(java.lang.String)"><CODE>setResultEntityName(String)</CODE></A></I></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/ProcedureQuery.html#setResultEntityName(java.lang.String)">setResultEntityName</A></B>(java.lang.String resultEntityName)</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/ProcedureQuery.html#setSelecting(boolean)">setSelecting</A></B>(boolean b)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 as this information is no longer relavant to Cayenne</I></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.AbstractQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getRoot()">getRoot</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">route</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#setRoot(java.lang.Object)">setRoot</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#toString()">toString</A></CODE></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.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.Query"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#getRoot()">getRoot</A>, <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>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setRoot(java.lang.Object)">setRoot</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.Query"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#getRoot()">getRoot</A>, <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>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setRoot(java.lang.Object)">setRoot</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="resultClassName"><!-- --></A><H3> |
| resultClassName</H3> |
| <PRE> |
| protected java.lang.String <B>resultClassName</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 'resultEntityName' must be used.</I><DD>If set, allows to fetch results as DataObjects. |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="resultEntityName"><!-- --></A><H3> |
| resultEntityName</H3> |
| <PRE> |
| protected java.lang.String <B>resultEntityName</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="resultClass"><!-- --></A><H3> |
| resultClass</H3> |
| <PRE> |
| protected java.lang.Class <B>resultClass</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="parameters"><!-- --></A><H3> |
| parameters</H3> |
| <PRE> |
| protected java.util.Map <B>parameters</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="selecting"><!-- --></A><H3> |
| selecting</H3> |
| <PRE> |
| protected boolean <B>selecting</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 as this information is no longer relavant to Cayenne</I><DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="resultDescriptors"><!-- --></A><H3> |
| resultDescriptors</H3> |
| <PRE> |
| protected java.util.List <B>resultDescriptors</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </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="ProcedureQuery()"><!-- --></A><H3> |
| ProcedureQuery</H3> |
| <PRE> |
| public <B>ProcedureQuery</B>()</PRE> |
| <DL> |
| <DD>Creates an empty procedure query. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="ProcedureQuery(org.apache.cayenne.map.Procedure)"><!-- --></A><H3> |
| ProcedureQuery</H3> |
| <PRE> |
| public <B>ProcedureQuery</B>(<A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A> procedure)</PRE> |
| <DL> |
| <DD>Creates a ProcedureQuery based on a Procedure object. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="ProcedureQuery(java.lang.String)"><!-- --></A><H3> |
| ProcedureQuery</H3> |
| <PRE> |
| public <B>ProcedureQuery</B>(java.lang.String procedureName)</PRE> |
| <DL> |
| <DD>Creates a ProcedureQuery based on a stored procedure. |
| <p> |
| Performance Note: with current EntityResolver implementation it is preferrable to |
| use Procedure object instead of String as a query root. String root can cause |
| unneeded EntityResolver reindexing on every call. See this mailing list thread: <a |
| href="http://objectstyle.org/cayenne/lists/cayenne-user/2005/01/0109.html"> |
| http://objectstyle.org/cayenne/lists/cayenne-user/2005/01/0109.html</a> |
| </p> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>procedureName</CODE> - A name of the stored procedure. For this query to work, a |
| procedure with this name must be mapped in Cayenne.</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ProcedureQuery(org.apache.cayenne.map.Procedure, java.lang.Class)"><!-- --></A><H3> |
| ProcedureQuery</H3> |
| <PRE> |
| public <B>ProcedureQuery</B>(<A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A> procedure, |
| java.lang.Class resultType)</PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ProcedureQuery(java.lang.String, java.lang.Class)"><!-- --></A><H3> |
| ProcedureQuery</H3> |
| <PRE> |
| public <B>ProcedureQuery</B>(java.lang.String procedureName, |
| java.lang.Class resultType)</PRE> |
| <DL> |
| <DD><p> |
| Performance Note: with current EntityResolver implementation it is preferrable to |
| use Procedure object instead of String as a query root. String root can cause |
| unneeded EntityResolver reindexing on every call. See this mailing list thread: <a |
| href="http://objectstyle.org/cayenne/lists/cayenne-user/2005/01/0109.html"> |
| http://objectstyle.org/cayenne/lists/cayenne-user/2005/01/0109.html</a> |
| </p> |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </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="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 class: <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">AbstractQuery</A></CODE></B></DD> |
| <DD>Returns default select parameters. |
| <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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResultDescriptors()"><!-- --></A><H3> |
| getResultDescriptors</H3> |
| <PRE> |
| public java.util.List <B>getResultDescriptors</B>()</PRE> |
| <DL> |
| <DD>Returns a List of #<A HREF="../../../../org/apache/cayenne/access/jdbc/RowDescriptor.html" title="class in org.apache.cayenne.access.jdbc"><CODE>RowDescriptor</CODE></A> objects describing query ResultSets in |
| the order they are returned by the stored procedure. |
| <p> |
| <i>Note that if a procedure returns ResultSet in an OUT parameter, it is returned |
| prior to any other result sets (though in practice database engines usually support |
| only one mechanism for returning result sets. </i> |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])"><!-- --></A><H3> |
| addResultDescriptor</H3> |
| <PRE> |
| public void <B>addResultDescriptor</B>(<A HREF="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</A>[] descriptor)</PRE> |
| <DL> |
| <DD>Adds a descriptor for a single ResultSet. More than one descriptor can be added by |
| calling this method multiple times in the order of described ResultSet appearance |
| in the procedure results. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])"><!-- --></A><H3> |
| removeResultDescriptor</H3> |
| <PRE> |
| public void <B>removeResultDescriptor</B>(<A HREF="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</A>[] descriptor)</PRE> |
| <DL> |
| <DD>Removes result descriptor from the list of descriptors. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </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>Calls "makeProcedure" on the visitor. |
| <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><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initWithProperties(java.util.Map)"><!-- --></A><H3> |
| initWithProperties</H3> |
| <PRE> |
| public void <B>initWithProperties</B>(java.util.Map properties)</PRE> |
| <DL> |
| <DD>Initializes query parameters using a set of properties. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </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>Prints itself as XML to the provided PrintWriter. |
| <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> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createQuery(java.util.Map)"><!-- --></A><H3> |
| createQuery</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> <B>createQuery</B>(java.util.Map parameters)</PRE> |
| <DL> |
| <DD>Creates and returns a new ProcedureQuery built using this query as a prototype and |
| substituting template parameters with the values from the map. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html#createQuery(java.util.Map)">createQuery</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCachePolicy()"><!-- --></A><H3> |
| getCachePolicy</H3> |
| <PRE> |
| public java.lang.String <B>getCachePolicy</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getCachePolicy()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns query cache policy, which can be one of <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#NO_CACHE"><CODE>GenericSelectQuery.NO_CACHE</CODE></A>, |
| <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#LOCAL_CACHE"><CODE>GenericSelectQuery.LOCAL_CACHE</CODE></A>, or <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#SHARED_CACHE"><CODE>GenericSelectQuery.SHARED_CACHE</CODE></A>. NO_CACHE is generally a default |
| policy. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getCachePolicy()">getCachePolicy</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCachePolicy(java.lang.String)"><!-- --></A><H3> |
| setCachePolicy</H3> |
| <PRE> |
| public void <B>setCachePolicy</B>(java.lang.String policy)</PRE> |
| <DL> |
| <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><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getFetchLimit()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns the limit on the maximium number of records that can be returned by this |
| query. If the actual number of rows in the result exceeds the fetch limit, they |
| will be discarded. One possible use of fetch limit is using it as a safeguard |
| against large result sets that may lead to the application running out of memory, |
| etc. If a fetch limit is greater or equal to zero, all rows will be returned. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getFetchLimit()">getFetchLimit</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the limit on the maximium number of records that can be returned by this |
| query</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchLimit(int)"><!-- --></A><H3> |
| setFetchLimit</H3> |
| <PRE> |
| public void <B>setFetchLimit</B>(int fetchLimit)</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><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPageSize()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns query page size. Page size is a hint to Cayenne that query should be |
| performed page by page, instead of retrieveing all results at once. If the value |
| returned is less than or equal to zero, no paging should occur. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPageSize()">getPageSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></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="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="isFetchingDataRows()"><!-- --></A><H3> |
| isFetchingDataRows</H3> |
| <PRE> |
| public boolean <B>isFetchingDataRows</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isFetchingDataRows()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects. This is a hint to |
| QueryEngine executing this query. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isFetchingDataRows()">isFetchingDataRows</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isRefreshingObjects()"><!-- --></A><H3> |
| isRefreshingObjects</H3> |
| <PRE> |
| public boolean <B>isRefreshingObjects</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isRefreshingObjects()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns <code>true</code> if the query results should replace any currently |
| cached values, returns <code>false</code> otherwise. If |
| <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isFetchingDataRows()"><CODE>GenericSelectQuery.isFetchingDataRows()</CODE></A>returns <code>true</code>, this setting is not |
| applicable and has no effect. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isRefreshingObjects()">isRefreshingObjects</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRefreshingObjects(boolean)"><!-- --></A><H3> |
| setRefreshingObjects</H3> |
| <PRE> |
| public void <B>setRefreshingObjects</B>(boolean flag)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isResolvingInherited()"><!-- --></A><H3> |
| isResolvingInherited</H3> |
| <PRE> |
| public boolean <B>isResolvingInherited</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isResolvingInherited()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns true if objects fetched via this query should be fully resolved according |
| to the inheritance hierarchy. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isResolvingInherited()">isResolvingInherited</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResolvingInherited(boolean)"><!-- --></A><H3> |
| setResolvingInherited</H3> |
| <PRE> |
| public void <B>setResolvingInherited</B>(boolean b)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addParameter(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| addParameter</H3> |
| <PRE> |
| public void <B>addParameter</B>(java.lang.String name, |
| java.lang.Object value)</PRE> |
| <DL> |
| <DD>Adds a named parameter to the internal map of parameters. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeParameter(java.lang.String)"><!-- --></A><H3> |
| removeParameter</H3> |
| <PRE> |
| public void <B>removeParameter</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParameters()"><!-- --></A><H3> |
| getParameters</H3> |
| <PRE> |
| public java.util.Map <B>getParameters</B>()</PRE> |
| <DL> |
| <DD>Returns a map of procedure parameters. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setParameters(java.util.Map)"><!-- --></A><H3> |
| setParameters</H3> |
| <PRE> |
| public void <B>setParameters</B>(java.util.Map parameters)</PRE> |
| <DL> |
| <DD>Sets a map of parameters. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearParameters()"><!-- --></A><H3> |
| clearParameters</H3> |
| <PRE> |
| public void <B>clearParameters</B>()</PRE> |
| <DL> |
| <DD>Cleans up all configured parameters. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResultClassName()"><!-- --></A><H3> |
| getResultClassName</H3> |
| <PRE> |
| public java.lang.String <B>getResultClassName</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 use <A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultEntityName()"><CODE>getResultEntityName()</CODE></A></I> |
| <P> |
| <DD>Returns an optional result type of the query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResultClass(java.lang.ClassLoader)"><!-- --></A><H3> |
| getResultClass</H3> |
| <PRE> |
| public java.lang.Class <B>getResultClass</B>(java.lang.ClassLoader classLoader)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2</I> |
| <P> |
| <DD>Returns Java class of the DataObjects returned by this query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResultClassName(java.lang.String)"><!-- --></A><H3> |
| setResultClassName</H3> |
| <PRE> |
| public void <B>setResultClassName</B>(java.lang.String resultClassName)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 use <A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName(java.lang.String)"><CODE>setResultEntityName(String)</CODE></A></I> |
| <P> |
| <DD>Sets optional result type of the query. A Class of the result type must be a |
| DataObject implementation mapped in Cayenne. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSelecting()"><!-- --></A><H3> |
| isSelecting</H3> |
| <PRE> |
| public boolean <B>isSelecting</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 as this information is no longer relavant to Cayenne</I> |
| <P> |
| <DD>Returns true if ProcedureQuery is expected to return a ResultSet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSelecting(boolean)"><!-- --></A><H3> |
| setSelecting</H3> |
| <PRE> |
| public void <B>setSelecting</B>(boolean b)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 as this information is no longer relavant to Cayenne</I> |
| <P> |
| <DD>Sets whether ProcedureQuery is expected to return a ResultSet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrefetchTree()"><!-- --></A><H3> |
| getPrefetchTree</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> <B>getPrefetchTree</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPrefetchTree()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPrefetchTree()">getPrefetchTree</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPrefetch(java.lang.String)"><!-- --></A><H3> |
| addPrefetch</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> <B>addPrefetch</B>(java.lang.String prefetchPath)</PRE> |
| <DL> |
| <DD>Adds a prefetch. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removePrefetch(java.lang.String)"><!-- --></A><H3> |
| removePrefetch</H3> |
| <PRE> |
| public void <B>removePrefetch</B>(java.lang.String prefetch)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPrefetches(java.util.Collection)"><!-- --></A><H3> |
| addPrefetches</H3> |
| <PRE> |
| public void <B>addPrefetches</B>(java.util.Collection prefetches)</PRE> |
| <DL> |
| <DD>Adds all prefetches from a provided collection. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearPrefetches()"><!-- --></A><H3> |
| clearPrefetches</H3> |
| <PRE> |
| public void <B>clearPrefetches</B>()</PRE> |
| <DL> |
| <DD>Clears all prefetches. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResultEntityName()"><!-- --></A><H3> |
| getResultEntityName</H3> |
| <PRE> |
| public java.lang.String <B>getResultEntityName</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResultEntityName(java.lang.String)"><!-- --></A><H3> |
| setResultEntityName</H3> |
| <PRE> |
| public void <B>setResultEntityName</B>(java.lang.String resultEntityName)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</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="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-files/index-1.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/PrefetchTreeNode.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.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/ProcedureQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ProcedureQuery.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> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
