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/EmptyQuery.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe/EmptyQuery.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/qe/EmptyQuery.html | 1051 |
1 files changed, 1051 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/qe/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html new file mode 100644 index 0000000..2a8af3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html @@ -0,0 +1,1051 @@ +<!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>EmptyQuery (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="EmptyQuery (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/EmptyQuery.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/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.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/EmptyQuery.html" target="_top">Frames</a></li> +<li><a href="EmptyQuery.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 EmptyQuery" class="title">Class EmptyQuery<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><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQuery</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.EmptyQuery<S></li> +</ul> +</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> +<hr> +<br> +<pre>public final class <span class="strong">EmptyQuery<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S></pre> +<div class="block">Special query implementation that fetches nothing.</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)">EmptyQuery</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String...)">EmptyQuery</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String... orderings)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String)">EmptyQuery</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String ordering)</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><T extends <a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#after(T)">after</a></strong>(T start)</code> +<div class="block">Returns a query which 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><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#count()">count</a></strong>()</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll()">deleteAll</a></strong>()</code> +<div class="block">Does nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Does nothing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.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">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#exists()">exists</a></strong>()</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch()">fetch</a></strong>()</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Always returns a <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#not()">not</a></strong>()</code> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> 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><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> +<div class="block">Returns a copy of this query ordered by specific property values.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#printNative(java.lang.Appendable, int)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#printPlan(java.lang.Appendable, int)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Always throws an IllegalStateException.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Always throws an IllegalStateException.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Always throws an IllegalStateException.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Always throws an IllegalStateException.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Always throws an IllegalStateException.</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Throws an IllegalStateException unless no values passed in.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQuery"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#checkSliceArguments(long, java.lang.Long)">checkSliceArguments</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative()">printNative</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative(java.lang.Appendable)">printNative</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan()">printPlan</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan(java.lang.Appendable)">printPlan</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</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 java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EmptyQuery</h4> +<pre>public EmptyQuery(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> ordering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - required query factory, used by 'or' and 'not' methods</dd><dd><code>ordering</code> - optional order-by properties</dd></dl> +</li> +</ul> +<a name="EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EmptyQuery</h4> +<pre>public EmptyQuery(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String ordering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - required query factory, used by 'or' and 'not' methods</dd><dd><code>ordering</code> - optional order-by property</dd></dl> +</li> +</ul> +<a name="EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EmptyQuery</h4> +<pre>public EmptyQuery(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String... orderings)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - required query factory, used by 'or' and 'not' methods</dd><dd><code>orderings</code> - optional order-by properties</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">Query</a></code></strong></div> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> getFilter()</pre> +<div class="block">Always returns a <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</li> +</ul> +<a name="getFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> getFilterValues()</pre> +<div class="block">Always returns null.</div> +</li> +</ul> +<a name="getBlankParameterCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlankParameterCount</h4> +<pre>public int getBlankParameterCount()</pre> +<div class="block">Always returns zero.</div> +</li> +</ul> +<a name="with(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(int value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(long value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(float value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(double value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(boolean value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(char value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(byte)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(byte value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(short)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(short value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(java.lang.Object value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="withValues(java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> withValues(java.lang.Object... values)</pre> +<div class="block">Throws an IllegalStateException unless no values passed in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - parameter values to fill in; if null or empty, this + Query instance is returned</dd></dl> +</li> +</ul> +<a name="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> and(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> or(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> 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(com.amazon.carbonado.filter.Filter)">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><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> not() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> orderBy(java.lang.String property) + 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#orderBy(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - name of property to order by</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="orderBy(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> orderBy(java.lang.String... properties) + 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#orderBy(java.lang.String...)">Query</a></code></strong></div> +<div class="block">Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - names of properties to order by</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="after(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="after(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>after</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> after(T start)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#after(T)">Query</a></code></strong></div> +<div class="block">Returns a query which 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 query may start at an earlier + position. + + <p>Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, this query is + returned</dd></dl> +</li> +</ul> +<a name="fetch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetch()</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>fetch results</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></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetch(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><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>fetch results</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></dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetchSlice(long from, + java.lang.Long to)</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetchSlice(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></pre> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</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/EmptyQuery.html" title="type parameter in EmptyQuery">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><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">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></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/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></pre> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</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/EmptyQuery.html" title="type parameter in EmptyQuery">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><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">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></dl> +</li> +</ul> +<a name="tryDeleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne()</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd></dl> +</li> +</ul> +<a name="tryDeleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns false.</div> +<dl><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>true if record existed and was deleted, or false if no match</dd></dl> +</li> +</ul> +<a name="deleteAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll()</pre> +<div class="block">Does nothing.</div> +</li> +</ul> +<a name="deleteAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Does nothing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count()</pre> +<div class="block">Always returns zero.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>count of matches</dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns zero.</div> +<dl><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>count of matches</dd></dl> +</li> +</ul> +<a name="exists()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists()</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd></dl> +</li> +</ul> +<a name="exists(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns false.</div> +<dl><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>true if any matches</dd></dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">Appender</a></code></strong></div> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel)</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel)</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public 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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public 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/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/EmptyQuery.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/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.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/EmptyQuery.html" target="_top">Frames</a></li> +<li><a href="EmptyQuery.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> |