diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/qe/AbstractQuery.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe/AbstractQuery.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/qe/AbstractQuery.html | 767 |
1 files changed, 767 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html new file mode 100644 index 0000000..a290d49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html @@ -0,0 +1,767 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AbstractQuery (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="AbstractQuery (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/AbstractQuery.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>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/AbstractQuery.html" target="_top">Frames</a></li> +<li><a href="AbstractQuery.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>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.qe</div> +<h2 title="Class AbstractQuery" class="title">Class AbstractQuery<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.AbstractQuery<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><S>, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractQuery<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><S>, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">AbstractQuery implements a small set of common Query methods. Subclasses + should consider overriding some of these methods, if it provides better + performance.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Query"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></h3> +<code><a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>, <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#AbstractQuery()">AbstractQuery</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#checkSliceArguments(long, java.lang.Long)">checkSliceArguments</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Called by sliced fetch to ensure that arguments are valid.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne</a></strong>()</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative()">printNative</a></strong>()</code> +<div class="block">Print the native query to standard out, which is useful for performance + analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative(java.lang.Appendable)">printNative</a></strong>(java.lang.Appendable app)</code> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan()">printPlan</a></strong>()</code> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan(java.lang.Appendable)">printPlan</a></strong>(java.lang.Appendable app)</code> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#toString()">toString</a></strong>()</code> +<div class="block">Implementation calls appendTo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne</a></strong>()</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Query"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></h3> +<code><a href="../../../../com/amazon/carbonado/Query.html#after(T)">after</a>, <a href="../../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/Query.html#count()">count</a>, <a href="../../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</a>, <a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a>, <a href="../../../../com/amazon/carbonado/Query.html#exists()">exists</a>, <a href="../../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetch()">fetch</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount</a>, <a href="../../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</a>, <a href="../../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</a>, <a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/Query.html#not()">not</a>, <a href="../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a>, <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a>, <a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">printNative</a>, <a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">printPlan</a>, <a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne</a>, <a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(byte)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(char)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(double)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(float)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(int)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(long)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(short)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</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="AbstractQuery()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractQuery</h4> +<pre>protected AbstractQuery()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="and(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> and(java.lang.String filter) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#and(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#and(java.lang.String)">and</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</dd> +<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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="or(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> or(java.lang.String filter) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#or(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#or(java.lang.String)">or</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</dd> +<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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="fetchAfter(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="fetchAfter(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAfter</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> fetchAfter(T start) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T)">Query</a></code></strong></div> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total + ordering, then cursor may start at an earlier position. + + <p>Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + + <p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, fetch all results</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../../com/amazon/carbonado/Query.html#after(T)"><code>Query.after(T)</code></a></dd></dl> +</li> +</ul> +<a name="fetchAfter(com.amazon.carbonado.Storable,com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a><a name="fetchAfter(T, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAfter</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> fetchAfter(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total + ordering, then cursor may start at an earlier position. + + <p>Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + + <p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, fetch all results</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../../com/amazon/carbonado/Query.html#after(T)"><code>Query.after(T)</code></a></dd></dl> +</li> +</ul> +<a name="loadOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> loadOne() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#loadOne()">Query</a></code></strong></div> +<div class="block">Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#loadOne()">loadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="loadOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> loadOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryLoadOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> tryLoadOne() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne()">Query</a></code></strong></div> +<div class="block">Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryLoadOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> tryLoadOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>public void deleteOne() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne()">Query</a></code></strong></div> +<div class="block">Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne()">deleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>public void deleteOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="printNative()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printNative()">Query</a></code></strong></div> +<div class="block">Print the native query to standard out, which is useful for performance + analysis. Not all repositories have a native query format. An example + native format is SQL.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printNative()">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">Query</a></code></strong></div> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printPlan()">Query</a></code></strong></div> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printPlan()">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">Query</a></code></strong></div> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Implementation calls appendTo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#toString()">toString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public abstract int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#hashCode()">hashCode</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public abstract boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="checkSliceArguments(long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>checkSliceArguments</h4> +<pre>protected boolean checkSliceArguments(long from, + java.lang.Long to)</pre> +<div class="block">Called by sliced fetch to ensure that arguments are valid.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if from is 0 and to is null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if arguments are invalid</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</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/AbstractQuery.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>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/AbstractQuery.html" target="_top">Frames</a></li> +<li><a href="AbstractQuery.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>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |