Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / query / QueryMetadata.html
blob: 25a0b25ccd695d1ab8deb0589a8686efe2aff167 [file] [log] [blame]
<!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 (1.8.0_112) on Mon Oct 14 11:36:14 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>QueryMetadata (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueryMetadata (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":38,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":38,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/QueryMetadataProxy.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cayenne/query/QueryMetadataProxy.html" title="class in org.apache.cayenne.query">QueryMetadataProxy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">QueryMetadata</span></pre>
<div class="block">Provides a common interface for accessing query metadata.</div>
<dl>
<dt><span class="simpleTagLabel">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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#CACHE_GROUPS_PROPERTY">CACHE_GROUPS_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#CACHE_STRATEGY_PROPERTY">CACHE_STRATEGY_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_LIMIT_DEFAULT">FETCH_LIMIT_DEFAULT</a></span></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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_LIMIT_PROPERTY">FETCH_LIMIT_PROPERTY</a></span></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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_OFFSET_DEFAULT">FETCH_OFFSET_DEFAULT</a></span></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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_OFFSET_PROPERTY">FETCH_OFFSET_PROPERTY</a></span></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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCHING_DATA_ROWS_DEFAULT">FETCHING_DATA_ROWS_DEFAULT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCHING_DATA_ROWS_PROPERTY">FETCHING_DATA_ROWS_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#PAGE_SIZE_DEFAULT">PAGE_SIZE_DEFAULT</a></span></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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#PAGE_SIZE_PROPERTY">PAGE_SIZE_PROPERTY</a></span></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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#STATEMENT_FETCH_SIZE_DEFAULT">STATEMENT_FETCH_SIZE_DEFAULT</a></span></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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#STATEMENT_FETCH_SIZE_PROPERTY">STATEMENT_FETCH_SIZE_PROPERTY</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheGroup--">getCacheGroup</a></span>()</code>
<div class="block">Returns an optional cache "group".</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheGroups--">getCacheGroups</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 4.0 only single cache group supported, use <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheGroup--"><code>getCacheGroup()</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheKey--">getCacheKey</a></span>()</code>
<div class="block">Returns a String that uniquely identifies this query for the purposes of result
caching.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheStrategy--">getCacheStrategy</a></span>()</code>
<div class="block">Returns a caching strategy for this query.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getClassDescriptor--">getClassDescriptor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getDataMap--">getDataMap</a></span>()</code>
<div class="block">Returns a DataMap associated with a query or null if no such DataMap exists.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getDbEntity--">getDbEntity</a></span>()</code>
<div class="block">Returns a DbEntity associated with a query or null if no such entity exists.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit--">getFetchLimit</a></span>()</code>
<div class="block">Returns the limit on the maximum number of records that can be returned by this
query.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchOffset--">getFetchOffset</a></span>()</code>
<div class="block">Specifies a start of a range when fetching a subset of records.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getObjEntity--">getObjEntity</a></span>()</code>
<div class="block">Returns an ObjEntity associated with a query or null if no such entity exists.</div>
</td>
</tr>
<tr id="i10" 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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getOrginatingQuery--">getOrginatingQuery</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 4.0, use <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getOriginatingQuery--"><code>getOriginatingQuery()</code></a></span></div>
</div>
</td>
</tr>
<tr id="i11" 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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getOriginatingQuery--">getOriginatingQuery</a></span>()</code>
<div class="block">Returns a query that originated this query.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getPageSize--">getPageSize</a></span>()</code>
<div class="block">Returns query page size.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getPathSplitAliases--">getPathSplitAliases</a></span>()</code>
<div class="block">Returns a map of aliases vs.</div>
</td>
</tr>
<tr id="i14" 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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getPrefetchTree--">getPrefetchTree</a></span>()</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 id="i15" 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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getProcedure--">getProcedure</a></span>()</code>
<div class="block">Returns a Procedure associated with a query or null if no such procedure exists.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getResultSetMapping--">getResultSetMapping</a></span>()</code>
<div class="block">Returns an optional list of result set mapping hints.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getStatementFetchSize--">getStatementFetchSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#isFetchingDataRows--">isFetchingDataRows</a></span>()</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 id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#isRefreshingObjects--">isRefreshingObjects</a></span>()</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>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#isSingleResultSetMapping--">isSingleResultSetMapping</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#isSuppressingDistinct--">isSuppressingDistinct</a></span>()</code>&nbsp;</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&nbsp;<a href="https://docs.oracle.com/javase/7/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="seeLabel">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&nbsp;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="seeLabel">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&nbsp;<a href="https://docs.oracle.com/javase/7/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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">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&nbsp;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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">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&nbsp;<a href="https://docs.oracle.com/javase/7/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="seeLabel">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&nbsp;int PAGE_SIZE_DEFAULT</pre>
<div class="block">Defines default query page size, which is zero for no pagination.</div>
<dl>
<dt><span class="seeLabel">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&nbsp;<a href="https://docs.oracle.com/javase/7/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="seeLabel">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&nbsp;boolean FETCHING_DATA_ROWS_DEFAULT</pre>
<dl>
<dt><span class="seeLabel">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&nbsp;<a href="https://docs.oracle.com/javase/7/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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">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&nbsp;<a href="https://docs.oracle.com/javase/7/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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">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&nbsp;<a href="https://docs.oracle.com/javase/7/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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">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&nbsp;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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">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>&nbsp;getClassDescriptor()</pre>
<dl>
<dt><span class="simpleTagLabel">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>&nbsp;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>&nbsp;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>&nbsp;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>&nbsp;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>&nbsp;getCacheStrategy()</pre>
<div class="block">Returns a caching strategy for this query.</div>
<dl>
<dt><span class="simpleTagLabel">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="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getCacheGroups()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 4.0 only single cache group supported, use <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheGroup--"><code>getCacheGroup()</code></a> instead</span></div>
<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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheGroup--"><code>getCacheGroup()</code></a></dd>
</dl>
</li>
</ul>
<a name="getCacheGroup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheGroup</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCacheGroup()</pre>
<div class="block">Returns an optional cache "group".
Cache groups allow to invalidate query caches in bulk on different events.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="isFetchingDataRows--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFetchingDataRows</h4>
<pre>boolean&nbsp;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&nbsp;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&nbsp;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&nbsp;getFetchOffset()</pre>
<div class="block">Specifies a start of a range when fetching a subset of records.</div>
<dl>
<dt><span class="simpleTagLabel">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&nbsp;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="returnLabel">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="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;getOrginatingQuery()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 4.0, use <a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getOriginatingQuery--"><code>getOriginatingQuery()</code></a></span></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="getOriginatingQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOriginatingQuery</h4>
<pre><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;getOriginatingQuery()</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="simpleTagLabel">Since:</span></dt>
<dd>4.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>&nbsp;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="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;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="simpleTagLabel">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="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="isSingleResultSetMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSingleResultSetMapping</h4>
<pre>boolean&nbsp;isSingleResultSetMapping()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>should the result be mapped to single object (scalar or entity)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/cayenne/query/QueryMetadata.html#getResultSetMapping--"><code>getResultSetMapping()</code></a></dd>
</dl>
</li>
</ul>
<a name="getStatementFetchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatementFetchSize</h4>
<pre>int&nbsp;getStatementFetchSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>statement's fetch size</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="isSuppressingDistinct--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isSuppressingDistinct</h4>
<pre>boolean&nbsp;isSuppressingDistinct()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/QueryMetadataProxy.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>