| <!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>QueryMetadata (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="QueryMetadata (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/QueryMetadata.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/QueryChain.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface 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/QueryMetadata.html" target="_top">Frames</a></li> |
| <li><a href="QueryMetadata.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>Constr | </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>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cayenne.query</div> |
| <h2 title="Interface QueryMetadata" class="title">Interface QueryMetadata</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">QueryMetadata</span></pre> |
| <div class="block">Provides a common interface for accessing query metadata.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</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>static <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/QueryMetadata.html#CACHE_GROUPS_PROPERTY">CACHE_GROUPS_PROPERTY</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/QueryMetadata.html#CACHE_STRATEGY_PROPERTY">CACHE_STRATEGY_PROPERTY</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_LIMIT_DEFAULT">FETCH_LIMIT_DEFAULT</a></strong></code> |
| <div class="block">Defines default query fetch limit, which is zero, meaning that all matching rows |
| should be fetched.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/QueryMetadata.html#FETCH_LIMIT_PROPERTY">FETCH_LIMIT_PROPERTY</a></strong></code> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit()"><code>fetch limit</code></a> |
| .</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_OFFSET_DEFAULT">FETCH_OFFSET_DEFAULT</a></strong></code> |
| <div class="block">Defines default query fetch start index, which is 0, meaning that matching rows |
| selected starting from the first.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/QueryMetadata.html#FETCH_OFFSET_PROPERTY">FETCH_OFFSET_PROPERTY</a></strong></code> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchOffset()"><code>fetch |
| offset</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCHING_DATA_ROWS_DEFAULT">FETCHING_DATA_ROWS_DEFAULT</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/QueryMetadata.html#FETCHING_DATA_ROWS_PROPERTY">FETCHING_DATA_ROWS_PROPERTY</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#PAGE_SIZE_DEFAULT">PAGE_SIZE_DEFAULT</a></strong></code> |
| <div class="block">Defines default query page size, which is zero for no pagination.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/QueryMetadata.html#PAGE_SIZE_PROPERTY">PAGE_SIZE_PROPERTY</a></strong></code> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getPageSize()"><code>page size</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#STATEMENT_FETCH_SIZE_DEFAULT">STATEMENT_FETCH_SIZE_DEFAULT</a></strong></code> |
| <div class="block">Defines default query fetch start index, which is 0, meaning that matching rows |
| selected starting from the first.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/QueryMetadata.html#STATEMENT_FETCH_SIZE_PROPERTY">STATEMENT_FETCH_SIZE_PROPERTY</a></strong></code> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getStatementFetchSize()"><code>fetch |
| size</code></a>.</div> |
| </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><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/QueryMetadata.html#getCacheGroups()">getCacheGroups</a></strong>()</code> |
| <div class="block">Returns an optional array of cache "groups".</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/QueryMetadata.html#getCacheKey()">getCacheKey</a></strong>()</code> |
| <div class="block">Returns a String that uniquely identifies this query for the purposes of result |
| caching.</div> |
| </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/QueryMetadata.html#getCacheStrategy()">getCacheStrategy</a></strong>()</code> |
| <div class="block">Returns a caching strategy for this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getClassDescriptor()">getClassDescriptor</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getDataMap()">getDataMap</a></strong>()</code> |
| <div class="block">Returns a DataMap associated with a query or null if no such DataMap exists.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getDbEntity()">getDbEntity</a></strong>()</code> |
| <div class="block">Returns a DbEntity associated with a query or null if no such entity exists.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit()">getFetchLimit</a></strong>()</code> |
| <div class="block">Returns the limit on the maximum number of records that can be returned by this |
| query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchOffset()">getFetchOffset</a></strong>()</code> |
| <div class="block">Specifies a start of a range when fetching a subset of records.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getObjEntity()">getObjEntity</a></strong>()</code> |
| <div class="block">Returns an ObjEntity associated with a query or null if no such entity exists.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/QueryMetadata.html#getOrginatingQuery()">getOrginatingQuery</a></strong>()</code> |
| <div class="block">Returns a query that originated this query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getPageSize()">getPageSize</a></strong>()</code> |
| <div class="block">Returns query page size.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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>,<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/QueryMetadata.html#getPathSplitAliases()">getPathSplitAliases</a></strong>()</code> |
| <div class="block">Returns a map of aliases vs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/QueryMetadata.html#getPrefetchTree()">getPrefetchTree</a></strong>()</code> |
| <div class="block">Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getProcedure()">getProcedure</a></strong>()</code> |
| <div class="block">Returns a Procedure associated with a query or null if no such procedure exists.</div> |
| </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="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/QueryMetadata.html#getResultSetMapping()">getResultSetMapping</a></strong>()</code> |
| <div class="block">Returns an optional list of result set mapping hints.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getStatementFetchSize()">getStatementFetchSize</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#isFetchingDataRows()">isFetchingDataRows</a></strong>()</code> |
| <div class="block">Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#isRefreshingObjects()">isRefreshingObjects</a></strong>()</code> |
| <div class="block">Returns <code>true</code> if the query results should replace any currently cached |
| values, returns <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| </table> |
| </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="FETCH_LIMIT_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_LIMIT_PROPERTY</h4> |
| <pre>static final <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> FETCH_LIMIT_PROPERTY</pre> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit()"><code>fetch limit</code></a> |
| .</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCH_LIMIT_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="FETCH_LIMIT_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_LIMIT_DEFAULT</h4> |
| <pre>static final int FETCH_LIMIT_DEFAULT</pre> |
| <div class="block">Defines default query fetch limit, which is zero, meaning that all matching rows |
| should be fetched.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCH_LIMIT_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="FETCH_OFFSET_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_OFFSET_PROPERTY</h4> |
| <pre>static final <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> FETCH_OFFSET_PROPERTY</pre> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchOffset()"><code>fetch |
| offset</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCH_OFFSET_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="FETCH_OFFSET_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_OFFSET_DEFAULT</h4> |
| <pre>static final int FETCH_OFFSET_DEFAULT</pre> |
| <div class="block">Defines default query fetch start index, which is 0, meaning that matching rows |
| selected starting from the first.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCH_OFFSET_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PAGE_SIZE_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PAGE_SIZE_PROPERTY</h4> |
| <pre>static final <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> PAGE_SIZE_PROPERTY</pre> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getPageSize()"><code>page size</code></a>.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.PAGE_SIZE_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PAGE_SIZE_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PAGE_SIZE_DEFAULT</h4> |
| <pre>static final int PAGE_SIZE_DEFAULT</pre> |
| <div class="block">Defines default query page size, which is zero for no pagination.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.PAGE_SIZE_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="FETCHING_DATA_ROWS_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCHING_DATA_ROWS_PROPERTY</h4> |
| <pre>static final <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> FETCHING_DATA_ROWS_PROPERTY</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCHING_DATA_ROWS_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="FETCHING_DATA_ROWS_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCHING_DATA_ROWS_DEFAULT</h4> |
| <pre>static final boolean FETCHING_DATA_ROWS_DEFAULT</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCHING_DATA_ROWS_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="CACHE_STRATEGY_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHE_STRATEGY_PROPERTY</h4> |
| <pre>static final <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> CACHE_STRATEGY_PROPERTY</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.CACHE_STRATEGY_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="CACHE_GROUPS_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHE_GROUPS_PROPERTY</h4> |
| <pre>static final <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> CACHE_GROUPS_PROPERTY</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.CACHE_GROUPS_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="STATEMENT_FETCH_SIZE_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STATEMENT_FETCH_SIZE_PROPERTY</h4> |
| <pre>static final <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> STATEMENT_FETCH_SIZE_PROPERTY</pre> |
| <div class="block">Defines the name of the property for the query <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getStatementFetchSize()"><code>fetch |
| size</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.STATEMENT_FETCH_SIZE_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="STATEMENT_FETCH_SIZE_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>STATEMENT_FETCH_SIZE_DEFAULT</h4> |
| <pre>static final int STATEMENT_FETCH_SIZE_DEFAULT</pre> |
| <div class="block">Defines default query fetch start index, which is 0, meaning that matching rows |
| selected starting from the first.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.STATEMENT_FETCH_SIZE_DEFAULT">Constant Field Values</a></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="getClassDescriptor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassDescriptor</h4> |
| <pre><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a> getClassDescriptor()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getObjEntity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjEntity</h4> |
| <pre><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> getObjEntity()</pre> |
| <div class="block">Returns an ObjEntity associated with a query or null if no such entity exists.</div> |
| </li> |
| </ul> |
| <a name="getDbEntity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbEntity</h4> |
| <pre><a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> getDbEntity()</pre> |
| <div class="block">Returns a DbEntity associated with a query or null if no such entity exists.</div> |
| </li> |
| </ul> |
| <a name="getProcedure()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProcedure</h4> |
| <pre><a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a> getProcedure()</pre> |
| <div class="block">Returns a Procedure associated with a query or null if no such procedure exists.</div> |
| </li> |
| </ul> |
| <a name="getDataMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataMap</h4> |
| <pre><a href="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> getDataMap()</pre> |
| <div class="block">Returns a DataMap associated with a query or null if no such DataMap exists.</div> |
| </li> |
| </ul> |
| <a name="getCacheStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStrategy</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> getCacheStrategy()</pre> |
| <div class="block">Returns a caching strategy for this query.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getCacheKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheKey</h4> |
| <pre><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> getCacheKey()</pre> |
| <div class="block">Returns a String that uniquely identifies this query for the purposes of result |
| caching. If null is returned, no caching is performed.</div> |
| </li> |
| </ul> |
| <a name="getCacheGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheGroups</h4> |
| <pre><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> |
| <div class="block">Returns an optional array of cache "groups". Cache groups allow to invalidate query |
| caches in bulk on different events. Usually the first group in the array is |
| considered to be the "main" group that is used for declarative cache invalidation |
| with some cache providers.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="isFetchingDataRows()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFetchingDataRows</h4> |
| <pre>boolean isFetchingDataRows()</pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="isRefreshingObjects()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRefreshingObjects</h4> |
| <pre>boolean isRefreshingObjects()</pre> |
| <div class="block">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/QueryMetadata.html#isFetchingDataRows()"><code>isFetchingDataRows()</code></a> |
| returns <code>true</code>, this setting is not applicable and has no effect.</div> |
| </li> |
| </ul> |
| <a name="getPageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageSize</h4> |
| <pre>int getPageSize()</pre> |
| <div class="block">Returns query page size. Page size is a hint to Cayenne that query should be |
| performed page by page, instead of retrieving all results at once. If the value |
| returned is less than or equal to zero, no paging should occur.</div> |
| </li> |
| </ul> |
| <a name="getFetchOffset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchOffset</h4> |
| <pre>int getFetchOffset()</pre> |
| <div class="block">Specifies a start of a range when fetching a subset of records.</div> |
| <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>int getFetchLimit()</pre> |
| <div class="block">Returns the limit on the maximum 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.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the limit on the maximum number of records that can be returned by this |
| query</dd></dl> |
| </li> |
| </ul> |
| <a name="getOrginatingQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrginatingQuery</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> getOrginatingQuery()</pre> |
| <div class="block">Returns a query that originated this query. Originating query is a query whose |
| result is needed to obtain the result of the query owning this metadata. Most often |
| than not the returned value is null. One example of non-null originating query is a |
| query for a range of objects in a previously fetched paginated list. The query that |
| fetched the original paginated list is an "originated" query. It may be used to |
| restore a list that got lost due to a cache overflow, etc.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrefetchTree()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefetchTree</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> getPrefetchTree()</pre> |
| <div class="block">Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured.</div> |
| </li> |
| </ul> |
| <a name="getPathSplitAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPathSplitAliases</h4> |
| <pre><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/String.html?is-external=true" title="class or interface in java.lang">String</a>> getPathSplitAliases()</pre> |
| <div class="block">Returns a map of aliases vs. expression subpaths that is used to build split joins.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getResultSetMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultSetMapping</h4> |
| <pre><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="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>> getResultSetMapping()</pre> |
| <div class="block">Returns an optional list of result set mapping hints. Elements in the list can be |
| either <a href="../../../../org/apache/cayenne/query/EntityResultSegment.html" title="interface in org.apache.cayenne.query"><code>EntityResultSegment</code></a> or <a href="../../../../org/apache/cayenne/query/ScalarResultSegment.html" title="interface in org.apache.cayenne.query"><code>ScalarResultSegment</code></a>. The returned |
| list can be null.</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>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/QueryMetadata.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/QueryChain.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface 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/QueryMetadata.html" target="_top">Frames</a></li> |
| <li><a href="QueryMetadata.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>Constr | </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>Constr | </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> |