blob: 0bba9a8048033057b4701adb94e5bff5efb90251 [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 (version 1.7.0_67) on Sat Sep 20 17:22:58 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>IngresSelectAction (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="IngresSelectAction (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/IngresSelectAction.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/dba/ingres/IngresPkGenerator.html" title="class in org.apache.cayenne.dba.ingres"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/dba/ingres/IngresSelectTranslator.html" title="class in org.apache.cayenne.dba.ingres"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/dba/ingres/IngresSelectAction.html" target="_top">Frames</a></li>
<li><a href="IngresSelectAction.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.cayenne.access.jdbc.SelectAction">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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.dba.ingres</div>
<h2 title="Class IngresSelectAction" class="title">Class IngresSelectAction</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/access/jdbc/BaseSQLAction.html" title="class in org.apache.cayenne.access.jdbc">org.apache.cayenne.access.jdbc.BaseSQLAction</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html" title="class in org.apache.cayenne.access.jdbc">org.apache.cayenne.access.jdbc.SelectAction</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.dba.ingres.IngresSelectAction</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">IngresSelectAction</span>
extends <a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html" title="class in org.apache.cayenne.access.jdbc">SelectAction</a></pre>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.access.jdbc.SelectAction">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.access.jdbc.<a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html" title="class in org.apache.cayenne.access.jdbc">SelectAction</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html#query">query</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.access.jdbc.BaseSQLAction">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.access.jdbc.<a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html" title="class in org.apache.cayenne.access.jdbc">BaseSQLAction</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#adapter">adapter</a>, <a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#entityResolver">entityResolver</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">&nbsp;</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/dba/ingres/IngresSelectAction.html#IngresSelectAction(org.apache.cayenne.query.SelectQuery,%20org.apache.cayenne.dba.JdbcAdapter,%20org.apache.cayenne.map.EntityResolver)">IngresSelectAction</a></strong>(<a href="../../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>&nbsp;query,
<a href="../../../../../org/apache/cayenne/dba/JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a>&nbsp;adapter,
<a href="../../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;entityResolver)</code>&nbsp;</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">&nbsp;</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>protected <a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html" title="class in org.apache.cayenne.access.trans">SelectTranslator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/dba/ingres/IngresSelectAction.html#createTranslator(java.sql.Connection)">createTranslator</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;connection)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/dba/ingres/IngresSelectAction.html#getInMemoryOffset(int)">getInMemoryOffset</a></strong>(int&nbsp;queryOffset)</code>
<div class="block">Returns a value of the offset that will be used to rewind the ResultSet within the
SQL action before reading the result rows.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.access.jdbc.SelectAction">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.access.jdbc.<a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html" title="class in org.apache.cayenne.access.jdbc">SelectAction</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html#performAction(java.sql.Connection,%20org.apache.cayenne.access.OperationObserver)">performAction</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.access.jdbc.BaseSQLAction">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.access.jdbc.<a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html" title="class in org.apache.cayenne.access.jdbc">BaseSQLAction</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#getAdapter()">getAdapter</a>, <a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#getEntityResolver()">getEntityResolver</a>, <a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#readResultSet(java.sql.ResultSet,%20org.apache.cayenne.access.jdbc.RowDescriptor,%20org.apache.cayenne.query.Query,%20org.apache.cayenne.access.OperationObserver)">readResultSet</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&nbsp;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#toString()" title="class or interface in java.lang">toString</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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IngresSelectAction(org.apache.cayenne.query.SelectQuery, org.apache.cayenne.dba.JdbcAdapter, org.apache.cayenne.map.EntityResolver)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IngresSelectAction</h4>
<pre>public&nbsp;IngresSelectAction(<a href="../../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>&nbsp;query,
<a href="../../../../../org/apache/cayenne/dba/JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a>&nbsp;adapter,
<a href="../../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;entityResolver)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInMemoryOffset(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInMemoryOffset</h4>
<pre>protected&nbsp;int&nbsp;getInMemoryOffset(int&nbsp;queryOffset)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#getInMemoryOffset(int)">BaseSQLAction</a></code></strong></div>
<div class="block">Returns a value of the offset that will be used to rewind the ResultSet within the
SQL action before reading the result rows. The default implementation returns
'queryOffset' argument. If the adapter supports setting offset at the SQL level,
this method must be overridden to return zero to suppress manual offset.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html#getInMemoryOffset(int)">getInMemoryOffset</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/jdbc/BaseSQLAction.html" title="class in org.apache.cayenne.access.jdbc">BaseSQLAction</a></code></dd>
</dl>
</li>
</ul>
<a name="createTranslator(java.sql.Connection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createTranslator</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/cayenne/access/trans/SelectTranslator.html" title="class in org.apache.cayenne.access.trans">SelectTranslator</a>&nbsp;createTranslator(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;connection)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html#createTranslator(java.sql.Connection)">createTranslator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/jdbc/SelectAction.html" title="class in org.apache.cayenne.access.jdbc">SelectAction</a></code></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/IngresSelectAction.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/dba/ingres/IngresPkGenerator.html" title="class in org.apache.cayenne.dba.ingres"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/dba/ingres/IngresSelectTranslator.html" title="class in org.apache.cayenne.dba.ingres"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/dba/ingres/IngresSelectAction.html" target="_top">Frames</a></li>
<li><a href="IngresSelectAction.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.cayenne.access.jdbc.SelectAction">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>