summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/Query.Controller.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/Query.Controller.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/Query.Controller.html')
-rw-r--r--apidocs/com/amazon/carbonado/Query.Controller.html307
1 files changed, 307 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/Query.Controller.html b/apidocs/com/amazon/carbonado/Query.Controller.html
new file mode 100644
index 0000000..1b949aa
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/Query.Controller.html
@@ -0,0 +1,307 @@
+<!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_25) on Tue Dec 03 13:53:40 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>Query.Controller (Carbonado 1.2.3 API)</title>
+<meta name="date" content="2013-12-03">
+<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="Query.Controller (Carbonado 1.2.3 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/Query.Controller.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-files/index-1.html">Index</a></li>
+<li><a href="../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?com/amazon/carbonado/Query.Controller.html" target="_top">Frames</a></li>
+<li><a href="Query.Controller.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>Field&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>Field&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">com.amazon.carbonado</div>
+<h2 title="Interface Query.Controller" class="title">Interface Query.Controller</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Superinterfaces:</dt>
+<dd>java.lang.AutoCloseable, java.io.Closeable, java.io.Serializable</dd>
+</dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dd>
+</dl>
+<dl>
+<dt>Enclosing interface:</dt>
+<dd><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</dd>
+</dl>
+<hr>
+<br>
+<pre>public static interface <span class="strong">Query.Controller</span>
+extends java.io.Serializable, java.io.Closeable</pre>
+<div class="block">Controller instance can be used to abort query operations.
+
+ <p>Example:<pre>
+ Storage&lt;UserInfo&gt; users = ...
+ long count = users.query("name = ?").count(Query.Timeout.seconds(10));
+ </pre></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== 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>void</code></td>
+<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#begin()">begin</a></strong>()</code>
+<div class="block">Called by query when it begins, possibly multiple times.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#close()">close</a></strong>()</code>
+<div class="block">Always called by query when finished, even when it fails.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">continueCheck</a></strong>()</code>
+<div class="block">Periodically called by query to determine if it should continue.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeout()">getTimeout</a></strong>()</code>
+<div class="block">Returns a non-negative value if controller imposes an absolute upper
+ bound on query execution time.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.util.concurrent.TimeUnit</code></td>
+<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">getTimeoutUnit</a></strong>()</code>
+<div class="block">Returns the unit for the timeout, if applicable.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getTimeout()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTimeout</h4>
+<pre>long&nbsp;getTimeout()</pre>
+<div class="block">Returns a non-negative value if controller imposes an absolute upper
+ bound on query execution time.</div>
+</li>
+</ul>
+<a name="getTimeoutUnit()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTimeoutUnit</h4>
+<pre>java.util.concurrent.TimeUnit&nbsp;getTimeoutUnit()</pre>
+<div class="block">Returns the unit for the timeout, if applicable.</div>
+</li>
+</ul>
+<a name="begin()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>begin</h4>
+<pre>void&nbsp;begin()</pre>
+<div class="block">Called by query when it begins, possibly multiple times. Implementation
+ is required to be idempotent and ignore multiple invocations.</div>
+</li>
+</ul>
+<a name="continueCheck()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>continueCheck</h4>
+<pre>void&nbsp;continueCheck()
+ throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Periodically called by query to determine if it should continue.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="close()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>close</h4>
+<pre>void&nbsp;close()</pre>
+<div class="block">Always called by query when finished, even when it fails. Implementation
+ is required to be idempotent and ignore multiple invocations.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</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/Query.Controller.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-files/index-1.html">Index</a></li>
+<li><a href="../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?com/amazon/carbonado/Query.Controller.html" target="_top">Frames</a></li>
+<li><a href="Query.Controller.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>Field&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>Field&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; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>