| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ProcedureQuery (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProcedureQuery (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProcedureQuery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/query/ProcedureQuery.html" target="_top">Frames</a></li> |
| <li><a href="ProcedureQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cayenne.query</div> |
| <h2 title="Class ProcedureQuery" class="title">Class ProcedureQuery</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.query.ProcedureQuery</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</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> |
| <br> |
| <pre>public class <span class="strong">ProcedureQuery</span> |
| extends <a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a> |
| implements <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></pre> |
| <div class="block">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></div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.ProcedureQuery">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#columnNamesCapitalization">columnNamesCapitalization</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#parameters">parameters</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultClass">resultClass</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultDescriptors">resultDescriptors</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultEntityName">resultEntityName</a></strong></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#dataMap">dataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#name">name</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#root">root</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery()">ProcedureQuery</a></strong>()</code> |
| <div class="block">Creates an empty procedure query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(org.apache.cayenne.map.Procedure)">ProcedureQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a> procedure)</code> |
| <div class="block">Creates a ProcedureQuery based on a Procedure object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(org.apache.cayenne.map.Procedure,%20java.lang.Class)">ProcedureQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a> procedure, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultType)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String)">ProcedureQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> procedureName)</code> |
| <div class="block">Creates a ProcedureQuery based on a stored procedure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String,%20java.lang.Class)">ProcedureQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> procedureName, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultType)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addParameter(java.lang.String,%20java.lang.Object)">addParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Adds a named parameter to the internal map of parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addPrefetch(java.lang.String)">addPrefetch</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</code> |
| <div class="block">Adds a prefetch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addPrefetches(java.util.Collection)">addPrefetches</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> prefetches)</code> |
| <div class="block">Adds all prefetches from a provided collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])">addResultDescriptor</a></strong>(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[] descriptor)</code> |
| <div class="block">Adds a descriptor for a single ResultSet.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#clearParameters()">clearParameters</a></strong>()</code> |
| <div class="block">Cleans up all configured parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#clearPrefetches()">clearPrefetches</a></strong>()</code> |
| <div class="block">Clears all prefetches.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#createQuery(java.util.Map)">createQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</code> |
| <div class="block">Creates and returns a new ProcedureQuery built using this query as a prototype and |
| substituting template parameters with the values from the map.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></strong>(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</code> |
| <div class="block">Calls "makeProcedure" on the visitor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></strong>(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</code> |
| <div class="block">Prints itself as XML to the provided PrintWriter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getCacheGroups()">getCacheGroups</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getCacheStrategy()">getCacheStrategy</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getColumnNamesCapitalization()">getColumnNamesCapitalization</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getFetchLimit()">getFetchLimit</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getFetchOffset()">getFetchOffset</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></strong>(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</code> |
| <div class="block">Returns default select parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getPageSize()">getPageSize</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getParameters()">getParameters</a></strong>()</code> |
| <div class="block">Returns a map of procedure parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getPrefetchTree()">getPrefetchTree</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultDescriptors()">getResultDescriptors</a></strong>()</code> |
| <div class="block">Returns a List of descriptors for query ResultSets in the order they are returned |
| by the stored procedure.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultEntityName()">getResultEntityName</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getStatementFetchSize()">getStatementFetchSize</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#initWithProperties(java.util.Map)">initWithProperties</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties)</code> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#isFetchingDataRows()">isFetchingDataRows</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#removeParameter(java.lang.String)">removeParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#removePrefetch(java.lang.String)">removePrefetch</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetch)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#removeResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])">removeResultDescriptor</a></strong>(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[] descriptor)</code> |
| <div class="block">Removes result descriptor from the list of descriptors.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setCacheGroups(java.lang.String...)">setCacheGroups</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... cacheGroups)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)">setCacheStrategy</a></strong>(<a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> strategy)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setColumnNamesCapitalization(org.apache.cayenne.query.CapsStrategy)">setColumnNamesCapitalization</a></strong>(<a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a> columnNameCapitalization)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows(boolean)">setFetchingDataRows</a></strong>(boolean flag)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchLimit(int)">setFetchLimit</a></strong>(int fetchLimit)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchOffset(int)">setFetchOffset</a></strong>(int fetchOffset)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setPageSize(int)">setPageSize</a></strong>(int pageSize)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setParameters(java.util.Map)">setParameters</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</code> |
| <div class="block">Sets a map of parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName(java.lang.String)">setResultEntityName</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resultEntityName)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setStatementFetchSize(int)">setStatementFetchSize</a></strong>(int size)</code> |
| <div class="block">Sets statement's fetch size (0 for no default size)</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getDataMap()">getDataMap</a>, <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,%20org.apache.cayenne.map.EntityResolver,%20org.apache.cayenne.query.Query)">route</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setDataMap(org.apache.cayenne.map.DataMap)">setDataMap</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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/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://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.query.Query"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../org/apache/cayenne/query/Query.html#getDataMap()">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getName()">getName</a>, <a href="../../../../org/apache/cayenne/query/Query.html#route(org.apache.cayenne.query.QueryRouter,%20org.apache.cayenne.map.EntityResolver,%20org.apache.cayenne.query.Query)">route</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.configuration.ConfigurationNode"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.configuration.<a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></h3> |
| <code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="resultEntityName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resultEntityName</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resultEntityName</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="resultClass"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resultClass</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultClass</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="columnNamesCapitalization"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnNamesCapitalization</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a> columnNamesCapitalization</pre> |
| </li> |
| </ul> |
| <a name="parameters"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> parameters</pre> |
| </li> |
| </ul> |
| <a name="resultDescriptors"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resultDescriptors</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]> resultDescriptors</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ProcedureQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProcedureQuery</h4> |
| <pre>public ProcedureQuery()</pre> |
| <div class="block">Creates an empty procedure query. The query would fetch DataRows. Fetching |
| Persistent objects can be achieved either by using |
| <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String,%20java.lang.Class)"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling |
| <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows(boolean)"><code>setFetchingDataRows(boolean)</code></a> and <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName(java.lang.String)"><code>setResultEntityName(String)</code></a> |
| methods.</div> |
| </li> |
| </ul> |
| <a name="ProcedureQuery(org.apache.cayenne.map.Procedure)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProcedureQuery</h4> |
| <pre>public ProcedureQuery(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a> procedure)</pre> |
| <div class="block">Creates a ProcedureQuery based on a Procedure object. The query would fetch |
| DataRows. Fetching Persistent objects can be achieved either by using |
| <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String,%20java.lang.Class)"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling |
| <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows(boolean)"><code>setFetchingDataRows(boolean)</code></a> and <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName(java.lang.String)"><code>setResultEntityName(String)</code></a> |
| methods.</div> |
| </li> |
| </ul> |
| <a name="ProcedureQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProcedureQuery</h4> |
| <pre>public ProcedureQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> procedureName)</pre> |
| <div class="block">Creates a ProcedureQuery based on a stored procedure. The query would fetch |
| DataRows. Fetching Persistent objects can be achieved either by using |
| <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery(java.lang.String,%20java.lang.Class)"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling |
| <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows(boolean)"><code>setFetchingDataRows(boolean)</code></a> and <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName(java.lang.String)"><code>setResultEntityName(String)</code></a> |
| methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><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.</dd></dl> |
| </li> |
| </ul> |
| <a name="ProcedureQuery(org.apache.cayenne.map.Procedure, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProcedureQuery</h4> |
| <pre>public ProcedureQuery(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a> procedure, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultType)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="ProcedureQuery(java.lang.String, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProcedureQuery</h4> |
| <pre>public ProcedureQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> procedureName, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultType)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMetaData(org.apache.cayenne.map.EntityResolver)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a> getMetaData(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">AbstractQuery</a></code></strong></div> |
| <div class="block">Returns default select parameters.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <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></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="getResultDescriptors()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultDescriptors</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]> getResultDescriptors()</pre> |
| <div class="block">Returns a List of descriptors for 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></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="addResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addResultDescriptor</h4> |
| <pre>public void addResultDescriptor(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[] descriptor)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="removeResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeResultDescriptor</h4> |
| <pre>public void removeResultDescriptor(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[] descriptor)</pre> |
| <div class="block">Removes result descriptor from the list of descriptors.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSQLAction</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a> createSQLAction(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</pre> |
| <div class="block">Calls "makeProcedure" on the visitor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="initWithProperties(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initWithProperties</h4> |
| <pre>public void initWithProperties(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties)</pre> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="encodeAsXML(org.apache.cayenne.util.XMLEncoder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeAsXML</h4> |
| <pre>public void encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</pre> |
| <div class="block">Prints itself as XML to the provided PrintWriter.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="createQuery(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createQuery</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> createQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</pre> |
| <div class="block">Creates and returns a new ProcedureQuery built using this query as a prototype and |
| substituting template parameters with the values from the map.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getCacheStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStrategy</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> getCacheStrategy()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStrategy</h4> |
| <pre>public void setCacheStrategy(<a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> strategy)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getCacheGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheGroups</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getCacheGroups()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setCacheGroups(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheGroups</h4> |
| <pre>public void setCacheGroups(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... cacheGroups)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getFetchLimit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchLimit</h4> |
| <pre>public int getFetchLimit()</pre> |
| </li> |
| </ul> |
| <a name="setFetchLimit(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchLimit</h4> |
| <pre>public void setFetchLimit(int fetchLimit)</pre> |
| </li> |
| </ul> |
| <a name="getFetchOffset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchOffset</h4> |
| <pre>public int getFetchOffset()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setFetchOffset(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchOffset</h4> |
| <pre>public void setFetchOffset(int fetchOffset)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getPageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageSize</h4> |
| <pre>public int getPageSize()</pre> |
| </li> |
| </ul> |
| <a name="setPageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageSize</h4> |
| <pre>public void setPageSize(int pageSize)</pre> |
| </li> |
| </ul> |
| <a name="setFetchingDataRows(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchingDataRows</h4> |
| <pre>public void setFetchingDataRows(boolean flag)</pre> |
| </li> |
| </ul> |
| <a name="isFetchingDataRows()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFetchingDataRows</h4> |
| <pre>public boolean isFetchingDataRows()</pre> |
| </li> |
| </ul> |
| <a name="addParameter(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addParameter</h4> |
| <pre>public void addParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Adds a named parameter to the internal map of parameters.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="removeParameter(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeParameter</h4> |
| <pre>public void removeParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getParameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameters</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> getParameters()</pre> |
| <div class="block">Returns a map of procedure parameters.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="setParameters(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameters</h4> |
| <pre>public void setParameters(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</pre> |
| <div class="block">Sets a map of parameters.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="clearParameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearParameters</h4> |
| <pre>public void clearParameters()</pre> |
| <div class="block">Cleans up all configured parameters.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrefetchTree()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefetchTree</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> getPrefetchTree()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="addPrefetch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetch</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> addPrefetch(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</pre> |
| <div class="block">Adds a prefetch.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="removePrefetch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePrefetch</h4> |
| <pre>public void removePrefetch(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetch)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="addPrefetches(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetches</h4> |
| <pre>public void addPrefetches(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> prefetches)</pre> |
| <div class="block">Adds all prefetches from a provided collection.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="clearPrefetches()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearPrefetches</h4> |
| <pre>public void clearPrefetches()</pre> |
| <div class="block">Clears all prefetches.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="getResultEntityName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultEntityName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getResultEntityName()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="setResultEntityName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultEntityName</h4> |
| <pre>public void setResultEntityName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resultEntityName)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="getColumnNamesCapitalization()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnNamesCapitalization</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a> getColumnNamesCapitalization()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setColumnNamesCapitalization(org.apache.cayenne.query.CapsStrategy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumnNamesCapitalization</h4> |
| <pre>public void setColumnNamesCapitalization(<a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a> columnNameCapitalization)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setStatementFetchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatementFetchSize</h4> |
| <pre>public void setStatementFetchSize(int size)</pre> |
| <div class="block">Sets statement's fetch size (0 for no default size)</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getStatementFetchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getStatementFetchSize</h4> |
| <pre>public int getStatementFetchSize()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>statement's fetch size</dd><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProcedureQuery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/query/ProcedureQuery.html" target="_top">Frames</a></li> |
| <li><a href="ProcedureQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
