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 | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe')
84 files changed, 25988 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> diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html new file mode 100644 index 0000000..8da05d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html @@ -0,0 +1,479 @@ +<!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>AbstractQueryExecutor (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="AbstractQueryExecutor (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/AbstractQueryExecutor.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/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum 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/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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 AbstractQueryExecutor" class="title">Class AbstractQueryExecutor<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.AbstractQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></pre> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</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"> +<!-- ======== 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/AbstractQueryExecutor.html#AbstractQueryExecutor()">AbstractQueryExecutor</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</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/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Produces a slice via skip and limit cursors.</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/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + 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">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a></strong>(int indentLevel)</code> +<div class="block">Adds a constant amount to the given indent level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Appends spaces to the given appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends a newline character.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Does nothing and returns false.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.QueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</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="AbstractQueryExecutor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractQueryExecutor</h4> +<pre>public AbstractQueryExecutor()</pre> +</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/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">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="fetchSlice(com.amazon.carbonado.filter.FilterValues, 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/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Produces a slice via skip and limit cursors. Subclasses are encouraged + to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchSlice(com.amazon.carbonado.filter.FilterValues, 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/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <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">Produces a slice via skip and limit cursors. Subclasses are encouraged + to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <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">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Does nothing and returns false.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</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="indent(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indent</h4> +<pre>protected void indent(java.lang.Appendable app, + int indentLevel) + throws java.io.IOException</pre> +<div class="block">Appends spaces to the given appendable. Useful for implementing + printNative and printPlan.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="newline(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newline</h4> +<pre>protected void newline(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends a newline character.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="increaseIndent(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>increaseIndent</h4> +<pre>protected int increaseIndent(int indentLevel)</pre> +<div class="block">Adds a constant amount to the given indent level. Useful for + implementing printNative and printPlan.</div> +</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/AbstractQueryExecutor.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/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum 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/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/BoundaryType.html new file mode 100644 index 0000000..e9fdeb2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/BoundaryType.html @@ -0,0 +1,347 @@ +<!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>BoundaryType (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="BoundaryType (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/BoundaryType.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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/CompositeScore.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/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum BoundaryType" class="title">Enum BoundaryType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.BoundaryType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">BoundaryType</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>></pre> +<div class="block">Describes a value range boundary.</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"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#EXCLUSIVE">EXCLUSIVE</a></strong></code> +<div class="block">Range boundary is exclusive</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#INCLUSIVE">INCLUSIVE</a></strong></code> +<div class="block">Range boundary is inclusive</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#OPEN">OPEN</a></strong></code> +<div class="block">Range boundary is open</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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>static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="OPEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OPEN</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> OPEN</pre> +<div class="block">Range boundary is open</div> +</li> +</ul> +<a name="INCLUSIVE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INCLUSIVE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> INCLUSIVE</pre> +<div class="block">Range boundary is inclusive</div> +</li> +</ul> +<a name="EXCLUSIVE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EXCLUSIVE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> EXCLUSIVE</pre> +<div class="block">Range boundary is exclusive</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (BoundaryType c : BoundaryType.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/BoundaryType.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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/CompositeScore.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/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/qe/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/CompositeScore.html new file mode 100644 index 0000000..55e6ffc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/CompositeScore.html @@ -0,0 +1,509 @@ +<!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>CompositeScore (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="CompositeScore (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/CompositeScore.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/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.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/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 CompositeScore" class="title">Class CompositeScore<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.CompositeScore<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">CompositeScore<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering. A composite score is not a single absolute value – instead it + has a relative weight when compared to other scores.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><code>FilteringScore</code></a>, +<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><code>OrderingScore</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)">canMergeRemainder</a></strong>(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#getFilteringScore()">getFilteringScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#getOrderingScore()">getOrderingScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator()">localForeignComparator</a></strong>()</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</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/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</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/CompositeScore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</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/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</code> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</code> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to evaluate</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexProperties</code> - index properties to evaluate</dd><dd><code>unique</code> - true if index is unique</dd><dd><code>clustered</code> - true if index is clustered</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="localForeignComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localForeignComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> localForeignComparator()</pre> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="localForeignComparator(com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localForeignComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> localForeignComparator(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hints</code> - optional hints</dd></dl> +</li> +</ul> +<a name="fullComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> fullComparator()</pre> +<div class="block">Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="fullComparator(com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> fullComparator(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block">Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hints</code> - optional hints</dd></dl> +</li> +</ul> +<a name="getFilteringScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilteringScore</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> getFilteringScore()</pre> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</li> +</ul> +<a name="getOrderingScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderingScore</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> getOrderingScore()</pre> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</li> +</ul> +<a name="canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainder</h4> +<pre>public boolean canMergeRemainder(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</pre> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</div> +</li> +</ul> +<a name="mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderFilter</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/CompositeScore.html" title="type parameter in CompositeScore">S</a>> mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</pre> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainder first to verify if the merge + makes any sense.</div> +</li> +</ul> +<a name="mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> mergeRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</pre> +<div class="block">Merges the remainder orderings of this score with the one given. Call + canMergeRemainder first to verify if the merge makes any sense.</div> +</li> +</ul> +<a name="withRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</pre> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated. Other matches are not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</pre> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced. Handled count is not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/CompositeScore.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/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.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/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html new file mode 100644 index 0000000..3805e4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html @@ -0,0 +1,557 @@ +<!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>DelegatedQueryExecutor (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="DelegatedQueryExecutor (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/DelegatedQueryExecutor.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/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.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/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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 DelegatedQueryExecutor" class="title">Class DelegatedQueryExecutor<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.DelegatedQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DelegatedQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></pre> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</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"> +<!-- ======== 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/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + 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">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the native query to any appendable, if applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DelegatedQueryExecutor</h4> +<pre>public DelegatedQueryExecutor(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootStorage</code> - root storage to query</dd><dd><code>executor</code> - executor to emulate</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DelegatedQueryExecutor</h4> +<pre>public DelegatedQueryExecutor(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootStorage</code> - root storage to query</dd><dd><code>filter</code> - optional query filter</dd><dd><code>ordering</code> - optional ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if rootStorage is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetchSlice(com.amazon.carbonado.filter.FilterValues, 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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to) + 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/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetchSlice(com.amazon.carbonado.filter.FilterValues, 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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <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/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Counts the query results using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Counts the query results using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the native query to any appendable, if applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</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(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</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> +</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/DelegatedQueryExecutor.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/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.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/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..dad3e85 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html @@ -0,0 +1,298 @@ +<!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>DelegatedQueryExecutorFactory (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="DelegatedQueryExecutorFactory (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/DelegatedQueryExecutorFactory.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/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.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/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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 DelegatedQueryExecutorFactory" class="title">Class DelegatedQueryExecutorFactory<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.DelegatedQueryExecutorFactory<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DelegatedQueryExecutorFactory<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</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"> +<!-- ======== 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/DelegatedQueryExecutorFactory.html#DelegatedQueryExecutorFactory(com.amazon.carbonado.Storage)">DelegatedQueryExecutorFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> rootStorage)</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#getStorableType()">getStorableType</a></strong>()</code> </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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="DelegatedQueryExecutorFactory(com.amazon.carbonado.Storage)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DelegatedQueryExecutorFactory</h4> +<pre>public DelegatedQueryExecutorFactory(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> rootStorage)</pre> +</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/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">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="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + 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/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">QueryExecutorFactory</a></code></strong></div> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">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> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</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></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/DelegatedQueryExecutorFactory.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/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.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/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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> 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> diff --git a/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html new file mode 100644 index 0000000..7153d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html @@ -0,0 +1,404 @@ +<!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>FilteredQueryExecutor (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="FilteredQueryExecutor (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/FilteredQueryExecutor.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/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteringScore.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/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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 FilteredQueryExecutor" class="title">Class FilteredQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.FilteredQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FilteredQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which wraps another and filters results.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><code>FilteredCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FilteredQueryExecutor.html#FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)">FilteredQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Prints native query of the wrapped executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FilteredQueryExecutor</h4> +<pre>public FilteredQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executor</code> - executor to wrap</dd><dd><code>filter</code> - filter to apply to cursor</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null or filter is open or closed</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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints native query of the wrapped executor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">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/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</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(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/FilteredQueryExecutor.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/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteringScore.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/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/FilteringScore.html new file mode 100644 index 0000000..e646914 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteringScore.html @@ -0,0 +1,932 @@ +<!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>FilteringScore (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="FilteringScore (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/FilteringScore.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/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.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/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 FilteringScore" class="title">Class FilteringScore<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.FilteringScore<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">FilteringScore<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Evaluates an index for how well it matches a query's desired filtering. A + filtering score is not a single absolute value – instead it has a + relative weight when compared to other scores. + + <p>An index matches a desired filtering if the arrangement of properties and + its relational operator matches. A matching <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>=</code></a> operator is + an identity match. A range match is determined by a matching operator of + <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>></code></a>, <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>>=</code></a>, <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code><</code></a>, or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code><=</code></a>. Filters with a <a href="../../../../com/amazon/carbonado/filter/RelOp.html#NE"><code>!=</code></a> operator are + ignored. Although not all index properties need to be used, the first must + be and no gaps are allowed. + + <p>A FilteringScore measures the number of filter properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform an + additional filtering operation to achieve the desired results. + + <p>In general, a FilteringScore is better than another if it has more + matched properties and fewer remainder properties. Matching more identity + properties is given preference over matching range properties. Index + clustering is also considered for score comparison.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><code>OrderingScore</code></a>, +<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><code>CompositeScore</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">canMergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which FilteringScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getArrangementScore()">getArrangementScore</a></strong>()</code> +<div class="block">Returns a value which indicates how well the index property order + matches the property filter specification order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringCount()">getCoveringCount</a></strong>()</code> +<div class="block">Returns number of covering property filters which are supported by the + evaluated index.</div> +</td> +</tr> +<tr class="altColor"> +<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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilter()">getCoveringFilter</a></strong>()</code> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilters()">getCoveringFilters</a></strong>()</code> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +</td> +</tr> +<tr class="altColor"> +<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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringRemainderFilter()">getCoveringRemainderFilter</a></strong>()</code> +<div class="block">Returns the composite remainder filter without including the covering + filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeEndFilters()">getExclusiveRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeStartFilters()">getExclusiveRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getHandledCount()">getHandledCount</a></strong>()</code> +<div class="block">Returns the count of all handled property filters.</div> +</td> +</tr> +<tr class="altColor"> +<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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getHandledFilter()">getHandledFilter</a></strong>()</code> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityCount()">getIdentityCount</a></strong>()</code> +<div class="block">Returns number of consecutive left-aligned index properties which match + property filters with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilter()">getIdentityFilter</a></strong>()</code> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilters()">getIdentityFilters</a></strong>()</code> +<div class="block">Returns the identity property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeEndFilters()">getInclusiveRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeStartFilters()">getInclusiveRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</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/FilteringScore.html#getIndexPropertyCount()">getIndexPropertyCount</a></strong>()</code> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Comparable</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getPreferenceScore()">getPreferenceScore</a></strong>()</code> +<div class="block">Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()">getRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()">getRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderCount()">getRemainderCount</a></strong>()</code> +<div class="block">Returns number of property filters not supported by the evaluated index.</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilters()">getRemainderFilters</a></strong>()</code> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasAnyMatches()">hasAnyMatches</a></strong>()</code> +<div class="block">Returns true if the identity count is greater than zero or if there is a + range match.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasRangeEnd()">hasRangeEnd</a></strong>()</code> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a> matches an index property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasRangeMatch()">hasRangeMatch</a></strong>()</code> +<div class="block">Returns true if there is both a range start and range end.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasRangeStart()">hasRangeStart</a></strong>()</code> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a> matches an index property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#isIndexClustered()">isIndexClustered</a></strong>()</code> +<div class="block">Returns true if evaluated index is clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#isIndexUnique()">isIndexUnique</a></strong>()</code> +<div class="block">Returns true if evaluated index is unique.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#isKeyMatch()">isKeyMatch</a></strong>()</code> +<div class="block">Returns true if evaluated index is unique and each of its properties has + an identity match.</div> +</td> +</tr> +<tr class="altColor"> +<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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">mergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#rangeComparator()">rangeComparator</a></strong>()</code> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#shouldReverseRange()">shouldReverseRange</a></strong>()</code> +<div class="block">Returns true if there is a range start or end match, but natural order + of matching property is descending.</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/FilteringScore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</code> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.</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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</pre> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to evaluate</dd><dd><code>filter</code> - filter which cannot contain any logical 'or' operations.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</pre> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexProperties</code> - index properties to evaluate</dd><dd><code>unique</code> - true if index is unique</dd><dd><code>clustered</code> - true if index is clustered</dd><dd><code>filter</code> - filter which cannot contain any logical 'or' operations.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="rangeComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rangeComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>> rangeComparator()</pre> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches. It does not matter + if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="fullComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>> fullComparator()</pre> +<div class="block">Returns a comparator which determines which FilteringScores are + better. It compares identity matches, range matches, open range matches + and property arrangement. It does not matter if the scores were + evaluated for different indexes or storable types. The comparator + returns <code><0</code> if first score is better, <code>0</code> if equal, or + <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="isIndexClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexClustered</h4> +<pre>public boolean isIndexClustered()</pre> +<div class="block">Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.</div> +</li> +</ul> +<a name="isIndexUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexUnique</h4> +<pre>public boolean isIndexUnique()</pre> +<div class="block">Returns true if evaluated index is unique.</div> +</li> +</ul> +<a name="getIndexPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexPropertyCount</h4> +<pre>public int getIndexPropertyCount()</pre> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</li> +</ul> +<a name="getIdentityCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityCount</h4> +<pre>public int getIdentityCount()</pre> +<div class="block">Returns number of consecutive left-aligned index properties which match + property filters with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</li> +</ul> +<a name="getIdentityFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getIdentityFilters()</pre> +<div class="block">Returns the identity property filters supported by the evaluated + index. The order of the list matches the order in which the properties + appear in the index. The operator of each filter is <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</li> +</ul> +<a name="getIdentityFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getIdentityFilter()</pre> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</li> +</ul> +<a name="hasRangeStart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRangeStart</h4> +<pre>public boolean hasRangeStart()</pre> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a> matches an index property. The index property used + for the range is the first one following the identity count.</div> +</li> +</ul> +<a name="getRangeStartFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRangeStartFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getRangeStartFilters()</pre> +<div class="block">Returns the range start property filters supported by the evaluated + index. The operator of each filter is either <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>. The property of each filter is identical, and the properties + are also identical to any range end filters.</div> +</li> +</ul> +<a name="getExclusiveRangeStartFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveRangeStartFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getExclusiveRangeStartFilters()</pre> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()"><code>getRangeStartFilters()</code></a>.</div> +</li> +</ul> +<a name="getInclusiveRangeStartFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInclusiveRangeStartFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getInclusiveRangeStartFilters()</pre> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()"><code>getRangeStartFilters()</code></a>.</div> +</li> +</ul> +<a name="hasRangeEnd()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRangeEnd</h4> +<pre>public boolean hasRangeEnd()</pre> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a> matches an index property. The index property used + for the range is the first one following the identity count.</div> +</li> +</ul> +<a name="getRangeEndFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRangeEndFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getRangeEndFilters()</pre> +<div class="block">Returns the range end property filters supported by the evaluated + index. The operator of each filter is either <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>. The property of each filter is identical, and the properties + are also identical to any range start filters.</div> +</li> +</ul> +<a name="getExclusiveRangeEndFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveRangeEndFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getExclusiveRangeEndFilters()</pre> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()"><code>getRangeEndFilters()</code></a>.</div> +</li> +</ul> +<a name="getInclusiveRangeEndFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInclusiveRangeEndFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getInclusiveRangeEndFilters()</pre> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()"><code>getRangeEndFilters()</code></a>.</div> +</li> +</ul> +<a name="getHandledCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledCount</h4> +<pre>public int getHandledCount()</pre> +<div class="block">Returns the count of all handled property filters.</div> +</li> +</ul> +<a name="getHandledFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getHandledFilter()</pre> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</li> +</ul> +<a name="hasRangeMatch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRangeMatch</h4> +<pre>public boolean hasRangeMatch()</pre> +<div class="block">Returns true if there is both a range start and range end.</div> +</li> +</ul> +<a name="hasAnyMatches()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasAnyMatches</h4> +<pre>public boolean hasAnyMatches()</pre> +<div class="block">Returns true if the identity count is greater than zero or if there is a + range match.</div> +</li> +</ul> +<a name="getArrangementScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArrangementScore</h4> +<pre>public int getArrangementScore()</pre> +<div class="block">Returns a value which indicates how well the index property order + matches the property filter specification order. A higher value + can indicate that the index is a slightly better match.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>arrangement value, never negative</dd></dl> +</li> +</ul> +<a name="getPreferenceScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreferenceScore</h4> +<pre>public java.lang.Comparable getPreferenceScore()</pre> +<div class="block">Returns a value which indicates user index preference, based on the + original ordering of elements in the filter. A higher value can + indicate that the index is a slightly better match.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>preference value which can be compared to another one</dd></dl> +</li> +</ul> +<a name="getRemainderCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderCount</h4> +<pre>public int getRemainderCount()</pre> +<div class="block">Returns number of property filters not supported by the evaluated index.</div> +</li> +</ul> +<a name="getRemainderFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilters</h4> +<pre>public java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getRemainderFilters()</pre> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</li> +</ul> +<a name="getRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getRemainderFilter()</pre> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</li> +</ul> +<a name="getCoveringCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringCount</h4> +<pre>public int getCoveringCount()</pre> +<div class="block">Returns number of covering property filters which are supported by the + evaluated index. This count is no more than the remainder count. If + hasAnyMatches returns false, then the covering count is zero.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getCoveringFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringFilters</h4> +<pre>public java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getCoveringFilters()</pre> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getCoveringFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getCoveringFilter()</pre> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getCoveringRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringRemainderFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getCoveringRemainderFilter()</pre> +<div class="block">Returns the composite remainder filter without including the covering + filter. Returns null if no remainder.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isKeyMatch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isKeyMatch</h4> +<pre>public boolean isKeyMatch()</pre> +<div class="block">Returns true if evaluated index is unique and each of its properties has + an identity match. When index and filter are used in a query, expect at + most one result.</div> +</li> +</ul> +<a name="shouldReverseRange()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldReverseRange</h4> +<pre>public boolean shouldReverseRange()</pre> +<div class="block">Returns true if there is a range start or end match, but natural order + of matching property is descending.</div> +</li> +</ul> +<a name="canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainderFilter</h4> +<pre>public boolean canMergeRemainderFilter(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</pre> +<div class="block">Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the remainder filter.</div> +</li> +</ul> +<a name="mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</pre> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainderFilter first to verify if the + merge makes any sense. Returns null if no remainder filter at all.</div> +</li> +</ul> +<a name="withRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</pre> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated. Other matches are not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/FilteringScore.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/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.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/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..2299151 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html @@ -0,0 +1,297 @@ +<!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>FullScanQueryExecutor.Support (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="FullScanQueryExecutor.Support (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/FullScanQueryExecutor.Support.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/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.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/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface FullScanQueryExecutor.Support" class="title">Interface FullScanQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">FullScanQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll()">countAll</a></strong>()</code> +<div class="block">Counts all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts all Storables.</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/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll</a></strong>()</code> +<div class="block">Perform a full scan of all Storables.</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/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#getStorableType()">getStorableType</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="countAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>countAll</h4> +<pre>long countAll() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="countAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>countAll</h4> +<pre>long countAll(<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">Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.</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">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetchAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAll</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>> fetchAll() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Perform a full scan of all Storables.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetchAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fetchAll</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>> fetchAll(<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">Perform a full scan of all Storables.</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">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +</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/FullScanQueryExecutor.Support.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/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.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/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html new file mode 100644 index 0000000..54f2300 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html @@ -0,0 +1,446 @@ +<!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>FullScanQueryExecutor (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="FullScanQueryExecutor (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/FullScanQueryExecutor.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/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface 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/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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 FullScanQueryExecutor" class="title">Class FullScanQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.FullScanQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FullScanQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</td> +</tr> +</table> +</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/FullScanQueryExecutor.html#FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)">FullScanQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> support)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</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/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns an open filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FullScanQueryExecutor</h4> +<pre>public FullScanQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> support)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - support for full scan</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if support is null</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="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">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/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <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 class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">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/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns an open filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns an empty list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/FullScanQueryExecutor.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/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface 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/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..300d9a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,518 @@ +<!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>IndexedQueryAnalyzer.Result (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="IndexedQueryAnalyzer.Result (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/IndexedQueryAnalyzer.Result.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/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.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/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 IndexedQueryAnalyzer.Result" class="title">Class IndexedQueryAnalyzer.Result</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexedQueryAnalyzer.Result</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">canMergeRemainder</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getCompositeScore()">getCompositeScore</a></strong>()</code> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignIndex()">getForeignIndex</a></strong>()</code> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignProperty()">getForeignProperty</a></strong>()</code> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getLocalIndex()">getLocalIndex</a></strong>()</code> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</td> +</tr> +<tr class="altColor"> +<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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Remainder filter which overrides that in composite score.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Remainder orderings which override that in composite score.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#handlesAnything()">handlesAnything</a></strong>()</code> +<div class="block">Returns true if the selected index does anything at all to filter + results or to order them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#isIndexClustered()">isIndexClustered</a></strong>()</code> +<div class="block">Returns true if local or foreign index is clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainderFilter(com.amazon.carbonado.filter.Filter)">mergeRemainderFilter</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</code> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</code> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</code> +<div class="block">Returns a new result with the remainder ordering replaced.</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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="handlesAnything()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handlesAnything</h4> +<pre>public boolean handlesAnything()</pre> +<div class="block">Returns true if the selected index does anything at all to filter + results or to order them. If not, a filtered and sorted full scan + makes more sense.</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getFilter()</pre> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getOrdering()</pre> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</li> +</ul> +<a name="getCompositeScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompositeScore</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getCompositeScore()</pre> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</li> +</ul> +<a name="getRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilter</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getRemainderFilter()</pre> +<div class="block">Remainder filter which overrides that in composite score.</div> +</li> +</ul> +<a name="getRemainderOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getRemainderOrdering()</pre> +<div class="block">Remainder orderings which override that in composite score.</div> +</li> +</ul> +<a name="getLocalIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocalIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getLocalIndex()</pre> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</li> +</ul> +<a name="getForeignIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getForeignIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><?> getForeignIndex()</pre> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected. If a foreign index has been selected, then a + <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>JoinedQueryExecutor</code></a> is needed.</div> +</li> +</ul> +<a name="getForeignProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getForeignProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getForeignProperty()</pre> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index. Returns null if foreign index was not selected. This + property corresponds to the "targetToSourceProperty" of <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>JoinedQueryExecutor</code></a>.</div> +</li> +</ul> +<a name="isIndexClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexClustered</h4> +<pre>public boolean isIndexClustered()</pre> +<div class="block">Returns true if local or foreign index is clustered. Scans of + clustered indexes are generally faster.</div> +</li> +</ul> +<a name="canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainder</h4> +<pre>public boolean canMergeRemainder(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</pre> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way. The only allowed differences are in the remainder + filter and orderings.</div> +</li> +</ul> +<a name="mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainder</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> mergeRemainder(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</pre> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result. Call canMergeRemainder first to + verify if the merge makes any sense.</div> +</li> +</ul> +<a name="mergeRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</pre> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result. If handlesAnything return true, then it + doesn't usually make sense to call this method.</div> +</li> +</ul> +<a name="withRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</pre> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</li> +</ul> +<a name="withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</pre> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</li> +</ul> +<a name="createExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExecutor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> createExecutor() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Creates a QueryExecutor based on this result.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/IndexedQueryAnalyzer.Result.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/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.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/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..b427293 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html @@ -0,0 +1,316 @@ +<!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>IndexedQueryAnalyzer (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="IndexedQueryAnalyzer (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/IndexedQueryAnalyzer.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/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.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/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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><a href="#nested_class_summary">Nested</a> | </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 IndexedQueryAnalyzer" class="title">Class IndexedQueryAnalyzer<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.IndexedQueryAnalyzer<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">IndexedQueryAnalyzer<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Analyzes a simple query specification and determines which index is best + suited for its execution. Query filters passed to this analyzer cannot + contain any 'or' operations. + + <p>IndexedQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><code>UnionQueryAnalyzer</code></a></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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></strong></code> </td> +</tr> +</table> +</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/IndexedQueryAnalyzer.html#IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">IndexedQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</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/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#getStorableType()">getStorableType</a></strong>()</code> </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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexedQueryAnalyzer</h4> +<pre>public IndexedQueryAnalyzer(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable being queried</dd><dd><code>access</code> - repository access for examing available indexes</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type or indexProvider is null</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>analyze</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> analyze(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter which which must be <a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()"><code>bound</code></a> and cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is not supported</dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/IndexedQueryAnalyzer.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/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.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/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..e841803 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html @@ -0,0 +1,375 @@ +<!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>IndexedQueryExecutor.Support (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="IndexedQueryExecutor.Support (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/IndexedQueryExecutor.Support.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/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.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/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface IndexedQueryExecutor.Support" class="title">Interface IndexedQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">IndexedQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</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/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</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/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</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/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</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><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index)</code> +<div class="block">Returns an open query if the given index supports query access.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="indexEntryQuery(com.amazon.carbonado.info.StorableIndex)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indexEntryQuery</h4> +<pre><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an open query if the given index supports query access. If + not supported, return null. An index entry query might be used to + perform filtering and sorting of index entries prior to being + resolved into referenced Storables. + + <p>If an index entry query is returned, the fetchSubset method is + never called by IndexedQueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>index entry query or null if not supported</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></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchFromIndexEntryQuery</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchFromIndexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open</dd><dd><code>indexEntryQuery</code> - query with no blank parameters, derived from + the query returned by indexEntryQuery</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></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchFromIndexEntryQuery</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchFromIndexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <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">Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open</dd><dd><code>indexEntryQuery</code> - query with no blank parameters, derived from + the query returned by indexEntryQuery</dd><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSubset</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchSubset(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + + <p>This method is only called if no index entry query was provided + for the given index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - optional list of exactly matching values to apply to index</dd><dd><code>rangeStartBoundary</code> - start boundary type</dd><dd><code>rangeStartValue</code> - value to start at if boundary is not open</dd><dd><code>rangeEndBoundary</code> - end boundary type</dd><dd><code>rangeEndValue</code> - value to end at if boundary is not open</dd><dd><code>reverseRange</code> - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.</dd><dd><code>reverseOrder</code> - when true, iteration should be reversed from its + natural order</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></dd></dl> +</li> +</ul> +<a name="fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fetchSubset</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchSubset(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <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">Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + + <p>This method is only called if no index entry query was provided + for the given index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - optional list of exactly matching values to apply to index</dd><dd><code>rangeStartBoundary</code> - start boundary type</dd><dd><code>rangeStartValue</code> - value to start at if boundary is not open</dd><dd><code>rangeEndBoundary</code> - end boundary type</dd><dd><code>rangeEndValue</code> - value to end at if boundary is not open</dd><dd><code>reverseRange</code> - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.</dd><dd><code>reverseOrder</code> - when true, iteration should be reversed from its + natural order</dd><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</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/IndexedQueryExecutor.Support.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/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.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/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html new file mode 100644 index 0000000..89c23a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html @@ -0,0 +1,436 @@ +<!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>IndexedQueryExecutor (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="IndexedQueryExecutor (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/IndexedQueryExecutor.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/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface 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/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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 IndexedQueryExecutor" class="title">Class IndexedQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.IndexedQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexedQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which utilizes an index.</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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</td> +</tr> +</table> +</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/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getCoveringFilter()">getCoveringFilter</a></strong>()</code> </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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexedQueryExecutor</h4> +<pre>public IndexedQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to use, which may be a primary key index</dd><dd><code>score</code> - score determines how best to utilize the index</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">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/AbstractQueryExecutor.html#getStorableType()">getStorableType</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getCoveringFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringFilter</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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getCoveringFilter()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if executor doesn't support or use a covering index</dd></dl> +</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/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/IndexedQueryExecutor.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/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface 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/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html new file mode 100644 index 0000000..42310dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html @@ -0,0 +1,386 @@ +<!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>IterableQueryExecutor (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="IterableQueryExecutor (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/IterableQueryExecutor.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/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.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/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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 IterableQueryExecutor" class="title">Class IterableQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.IterableQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IterableQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><code>IteratorCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable)">IterableQueryExecutor</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable, java.util.concurrent.locks.Lock)">IterableQueryExecutor</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable, + java.util.concurrent.locks.Lock lock)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns an open filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="IterableQueryExecutor(java.lang.Class, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IterableQueryExecutor</h4> +<pre>public IterableQueryExecutor(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable</dd><dd><code>iterable</code> - collection to iterate over, or null for empty cursor</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd></dl> +</li> +</ul> +<a name="IterableQueryExecutor(java.lang.Class, java.lang.Iterable, java.util.concurrent.locks.Lock)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IterableQueryExecutor</h4> +<pre>public IterableQueryExecutor(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable, + java.util.concurrent.locks.Lock lock)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable</dd><dd><code>iterable</code> - collection to iterate over, or null for empty cursor</dd><dd><code>lock</code> - optional lock to hold while cursor is open</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</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="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/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns an open filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns an empty list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/IterableQueryExecutor.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/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.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/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html new file mode 100644 index 0000000..e8fd436 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html @@ -0,0 +1,374 @@ +<!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>JoinedQueryExecutor (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="JoinedQueryExecutor (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/JoinedQueryExecutor.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/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.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/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 JoinedQueryExecutor" class="title">Class JoinedQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T 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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><T></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.JoinedQueryExecutor<S,T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - source type</dd><dd><code>T</code> - target type</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">JoinedQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><T></pre> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type. The source executor is called once per + fetch (outer loop), but the target executor is called once per source result + (inner loop).</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"> +<!-- ========== 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>static <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</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/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</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/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public static <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T> build(<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins. Filtering and ordering may also be supplied, + in order to better distribute work throughout the join.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repoAccess</code> - used to create query executors for outer and inner loops</dd><dd><code>targetToSourceProperty</code> - join property of <i>target</i> type which maps + to instances of <i>source</i> type</dd><dd><code>targetFilter</code> - optional filter for fetching <i>target</i> instances</dd><dd><code>targetOrdering</code> - optional ordering to apply to <i>target</i> executor + & @param hints optional hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or if join + property is not a Storable type</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - from RepositoryAccess</dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/JoinedQueryExecutor.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/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.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/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..ec60bce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html @@ -0,0 +1,254 @@ +<!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>KeyQueryExecutor.Support (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="KeyQueryExecutor.Support (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/KeyQueryExecutor.Support.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/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingList.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/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface KeyQueryExecutor.Support" class="title">Interface KeyQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">KeyQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues)</code> +<div class="block">Select at most one Storable referenced by an index.</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/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchOne</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> fetchOne(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - of exactly matching values to apply to index</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></dd></dl> +</li> +</ul> +<a name="fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fetchOne</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> fetchOne(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <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">Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - of exactly matching values to apply to index</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></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/KeyQueryExecutor.Support.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/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingList.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/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html new file mode 100644 index 0000000..4a39b5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html @@ -0,0 +1,421 @@ +<!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>KeyQueryExecutor (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="KeyQueryExecutor (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/KeyQueryExecutor.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/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface 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/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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 KeyQueryExecutor" class="title">Class KeyQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.KeyQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">KeyQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</td> +</tr> +</table> +</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/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyQueryExecutor</h4> +<pre>public KeyQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to use, which may be a primary key index</dd><dd><code>score</code> - score determines how best to utilize the index</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or if index is + not unique or if score is not a key match</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/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">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/AbstractQueryExecutor.html#getStorableType()">getStorableType</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns an empty list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/KeyQueryExecutor.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/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface 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/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/OrderingList.html b/apidocs/com/amazon/carbonado/qe/OrderingList.html new file mode 100644 index 0000000..f33cfe9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingList.html @@ -0,0 +1,559 @@ +<!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>OrderingList (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="OrderingList (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/OrderingList.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/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingScore.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/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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><a href="#fields_inherited_from_class_java.util.AbstractList">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 OrderingList" class="title">Class OrderingList<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>java.util.AbstractCollection<E></li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.OrderingList<S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Iterable<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>>, java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>>, java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OrderingList<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> +implements java.io.Serializable</pre> +<div class="block">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>. Instances + are immutable, canonical and cached. Calls to "equals" and "hashCode" are + fast.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.amazon.carbonado.qe.OrderingList">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_java.util.AbstractList"> +<!-- --> +</a> +<h3>Fields inherited from class java.util.AbstractList</h3> +<code>modCount</code></li> +</ul> +</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/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#concat(java.lang.Class, java.lang.String)">concat</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> type, + java.lang.String property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</code> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#emptyList()">emptyList</a></strong>()</code> +<div class="block">Returns a canonical empty instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get</a></strong>(java.lang.Class<S> type, + java.lang.String... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get</a></strong>(java.lang.Class<S> type, + java.lang.String property)</code> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(int)">get</a></strong>(int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#reduce()">reduce</a></strong>()</code> +<div class="block">Eliminates redundant ordering properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace</a></strong>(int index, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list with the given element replaced.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#reverseDirections()">reverseDirections</a></strong>()</code> +<div class="block">Returns this list with all orderings in reverse.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#size()">size</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#subList(int, int)">subList</a></strong>(int fromIndex, + int toIndex)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractList"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractList</h3> +<code>add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractCollection</h3> +<code>addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString</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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.List"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.List</h3> +<code>addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="emptyList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emptyList</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> emptyList()</pre> +<div class="block">Returns a canonical empty instance.</div> +</li> +</ul> +<a name="get(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(java.lang.Class<S> type, + java.lang.String property)</pre> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if ordering property is not in S</dd></dl> +</li> +</ul> +<a name="get(java.lang.Class, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(java.lang.Class<S> type, + java.lang.String... orderings)</pre> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any ordering property is not in S</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.OrderedProperty...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</pre> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</li> +</ul> +<a name="get(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</pre> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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>size</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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>size</code> in class <code>java.util.AbstractCollection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="get(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> get(int index)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>get</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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>get</code> in class <code>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="concat(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>concat</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> concat(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> type, + java.lang.String property)</pre> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</li> +</ul> +<a name="concat(com.amazon.carbonado.info.OrderedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>concat</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> concat(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</pre> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</li> +</ul> +<a name="concat(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>concat</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> concat(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</pre> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</li> +</ul> +<a name="reduce()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> reduce()</pre> +<div class="block">Eliminates redundant ordering properties.</div> +</li> +</ul> +<a name="reverseDirections()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverseDirections</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> reverseDirections()</pre> +<div class="block">Returns this list with all orderings in reverse.</div> +</li> +</ul> +<a name="replace(int, com.amazon.carbonado.info.OrderedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> replace(int index, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</pre> +<div class="block">Returns a list with the given element replaced.</div> +</li> +</ul> +<a name="subList(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subList</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> subList(int fromIndex, + int toIndex)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>subList</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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>subList</code> in class <code>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="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>hashCode</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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>hashCode</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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 other)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>equals</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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>equals</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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/OrderingList.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/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingScore.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/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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><a href="#fields_inherited_from_class_java.util.AbstractList">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/OrderingScore.html new file mode 100644 index 0000000..6b327ce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingScore.html @@ -0,0 +1,547 @@ +<!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>OrderingScore (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="OrderingScore (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/OrderingScore.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/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryEngine.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/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 OrderingScore" class="title">Class OrderingScore<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.OrderingScore<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">OrderingScore<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Evaluates an index for how well it matches a query's desired ordering. An + ordering score is not a single absolute value – instead it has a relative + weight when compared to other scores. + + <p>An index matches a desired ordering if the arrangement of properties + matches. Not all properties of the index need to be used, however. Also, + gaps in the arrangement are allowed if a property identity filter + matches. A property identity filter is of the form <code>"a = ?"</code>. + + <p>An OrderingScore measures the number of ordering properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform a + post-sort operation to achieve the desired results. + + <p>In general, an OrderingScore is better than another if it has more + matched properties and fewer remainder properties. Index clustering, + property count, and natural order is also considered.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><code>FilteringScore</code></a>, +<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><code>CompositeScore</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">canMergeRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which OrderingScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getFreeOrdering()">getFreeOrdering</a></strong>()</code> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getHandledCount()">getHandledCount</a></strong>()</code> +<div class="block">Returns the number of desired orderings the evaluated index + supports.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getHandledOrdering()">getHandledOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index supports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getIndexPropertyCount()">getIndexPropertyCount</a></strong>()</code> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getRemainderCount()">getRemainderCount</a></strong>()</code> +<div class="block">Returns the number of desired orderings the evaluated index does not + support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index does not + support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getUnusedOrdering()">getUnusedOrdering</a></strong>()</code> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#isIndexClustered()">isIndexClustered</a></strong>()</code> +<div class="block">Returns true if evaluated index is clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#shouldReverseOrder()">shouldReverseOrder</a></strong>()</code> +<div class="block">Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</code> +<div class="block">Returns a new OrderingScore with the remainder replaced.</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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to evaluate</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexProperties</code> - index properties to evaluate</dd><dd><code>unique</code> - true if index is unique</dd><dd><code>clustered</code> - true if index is clustered</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="fullComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><?>> fullComparator()</pre> +<div class="block">Returns a comparator which determines which OrderingScores are + better. It does not matter if the scores were evaluated for different + indexes or storable types. The comparator returns <code><0</code> if first + score is better, <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="isIndexClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexClustered</h4> +<pre>public boolean isIndexClustered()</pre> +<div class="block">Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.</div> +</li> +</ul> +<a name="getIndexPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexPropertyCount</h4> +<pre>public int getIndexPropertyCount()</pre> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</li> +</ul> +<a name="getHandledCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledCount</h4> +<pre>public int getHandledCount()</pre> +<div class="block">Returns the number of desired orderings the evaluated index + supports. The number of orderings is reduced to eliminate redundancies.</div> +</li> +</ul> +<a name="getHandledOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getHandledOrdering()</pre> +<div class="block">Returns the ordering properties that the evaluated index supports. The + list of orderings is reduced to eliminate redundancies. If any handled + ordering properties originally had an unspecified direction, the correct + direction is specified in this list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>handled orderings, never null</dd></dl> +</li> +</ul> +<a name="getRemainderCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderCount</h4> +<pre>public int getRemainderCount()</pre> +<div class="block">Returns the number of desired orderings the evaluated index does not + support. The number of orderings is reduced to eliminate redundancies. + When the remainder count is non-zero, a query plan which uses the + evaluated index must perform a sort.</div> +</li> +</ul> +<a name="getRemainderOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getRemainderOrdering()</pre> +<div class="block">Returns the ordering properties that the evaluated index does not + support. The list of orderings is reduced to eliminate redundancies.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>remainder orderings, never null</dd></dl> +</li> +</ul> +<a name="shouldReverseOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldReverseOrder</h4> +<pre>public boolean shouldReverseOrder()</pre> +<div class="block">Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.</div> +</li> +</ul> +<a name="getFreeOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFreeOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getFreeOrdering()</pre> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings. The + direction of any free orderings may be UNSPECIFIED, which indicates that + specific order is not relevant.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>free orderings, never null</dd></dl> +</li> +</ul> +<a name="getUnusedOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnusedOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getUnusedOrdering()</pre> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out. The direction of each unused ordering is UNSPECIFIED + because specific order is not relevant.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>unused orderings, never null</dd></dl> +</li> +</ul> +<a name="canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainderOrdering</h4> +<pre>public boolean canMergeRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</pre> +<div class="block">Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the count of remainder + orderings.</div> +</li> +</ul> +<a name="mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> mergeRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</pre> +<div class="block">Merges the remainder orderings of this score with the one given. Call + canMergeRemainderOrdering first to verify if the merge makes any sense.</div> +</li> +</ul> +<a name="withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</pre> +<div class="block">Returns a new OrderingScore with the remainder replaced. Handled count + is not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/OrderingScore.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/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryEngine.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/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/QueryEngine.html new file mode 100644 index 0000000..fdcbeb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryEngine.html @@ -0,0 +1,329 @@ +<!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>QueryEngine (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="QueryEngine (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/QueryEngine.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/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface 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/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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 QueryEngine" class="title">Class QueryEngine<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/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.StandardQueryFactory</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryEngine<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>, <a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryEngine<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/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><S> +implements <a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">Complete rule-based query engine implementation.</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"> +<!-- ======== 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/QueryEngine.html#QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">QueryEngine</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</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>protected <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.StandardQueryFactory"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#clearExecutors()">clearExecutors</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#resetExecutors()">resetExecutors</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#setExecutors()">setExecutors</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.QueryExecutorFactory"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</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="QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryEngine</h4> +<pre>public QueryEngine(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">QueryExecutorFactory</a></code></strong></div> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">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> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createQuery</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> createQuery(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQueryFactory</a></code></strong></div> +<div class="block">Implement this method to return query implementations.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">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> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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/QueryEngine.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/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface 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/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html new file mode 100644 index 0000000..b3f7950 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html @@ -0,0 +1,437 @@ +<!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>QueryExecutor (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="QueryExecutor (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/QueryExecutor.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/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.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/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface QueryExecutor" class="title">Interface QueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">QueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Performs all the actual work of executing a query. QueryExecutors are linked + together forming a <i>query plan</i>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutorFactory</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</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/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</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/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</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/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + 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">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<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/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Prints the native query to any appendable, if applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> getStorableType()</pre> +<div class="block">Returns the storable type that this executor operates on.</div> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <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">Returns a new cursor using the given filter values.</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">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <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">Returns a new cursor using the given filter values and slice.</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">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts the query results using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <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">Counts the query results using the given filter values.</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">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints the native query to any appendable, if applicable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - optional</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(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - optional</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> +</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/QueryExecutor.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/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.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/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html new file mode 100644 index 0000000..9d73f5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html @@ -0,0 +1,300 @@ +<!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>QueryExecutorCache (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="QueryExecutorCache (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/QueryExecutorCache.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/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface 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/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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 QueryExecutorCache" class="title">Class QueryExecutorCache<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.QueryExecutorCache<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryExecutorCache<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them. By default, a minimum of 100 query executors can be cached per Storable type. + The minimum can be changed with the + "com.amazon.carbonado.qe.QueryExecutorCache.minCapacity" system property.</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"> +<!-- ======== 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/QueryExecutorCache.html#QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)">QueryExecutorCache</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> factory)</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#getStorableType()">getStorableType</a></strong>()</code> </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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryExecutorCache</h4> +<pre>public QueryExecutorCache(<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> factory)</pre> +</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/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">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="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an executor from the cache.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">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> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/QueryExecutorCache.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/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface 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/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html new file mode 100644 index 0000000..f8d3b30 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html @@ -0,0 +1,239 @@ +<!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>QueryExecutorFactory (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="QueryExecutorFactory (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/QueryExecutorFactory.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/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface 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/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface QueryExecutorFactory" class="title">Interface QueryExecutorFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a>, <a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a>, <a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">QueryExecutorFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</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"> +<!-- ========== 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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/QueryExecutorFactory.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/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface 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/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/QueryFactory.html new file mode 100644 index 0000000..4cad899 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryFactory.html @@ -0,0 +1,241 @@ +<!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>QueryFactory (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="QueryFactory (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/QueryFactory.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/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum 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/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface QueryFactory" class="title">Interface QueryFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">QueryFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</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"> +<!-- ========== 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>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#getStorableType()">getStorableType</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/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>query</h4> +<pre><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a query that handles the given query specification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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></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/QueryFactory.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/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum 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/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryHint.html b/apidocs/com/amazon/carbonado/qe/QueryHint.html new file mode 100644 index 0000000..41f32ac --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHint.html @@ -0,0 +1,320 @@ +<!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>QueryHint (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="QueryHint (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/QueryHint.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/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHints.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/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum QueryHint" class="title">Enum QueryHint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryHint</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">QueryHint</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>></pre> +<div class="block">Defines a hint key.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><code>QueryHints</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHint.html#CONSUME_SLICE">CONSUME_SLICE</a></strong></code> +<div class="block">Intention to consume a slice of matched records</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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>static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHint.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHint.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="CONSUME_SLICE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CONSUME_SLICE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> CONSUME_SLICE</pre> +<div class="block">Intention to consume a slice of matched records</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (QueryHint c : QueryHint.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/QueryHint.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/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHints.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/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryHints.html b/apidocs/com/amazon/carbonado/qe/QueryHints.html new file mode 100644 index 0000000..6e631c7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHints.html @@ -0,0 +1,387 @@ +<!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>QueryHints (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="QueryHints (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/QueryHints.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/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface 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/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 QueryHints" class="title">Class QueryHints</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryHints</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryHints</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">An immutable map of query hints.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><code>QueryHint</code></a>, +<a href="../../../../serialized-form.html#com.amazon.carbonado.qe.QueryHints">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#contains(com.amazon.carbonado.qe.QueryHint)">contains</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns false if hint is not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#emptyHints()">emptyHints</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns null if hint is not provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="emptyHints()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emptyHints</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> emptyHints()</pre> +</li> +</ul> +<a name="with(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> with(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns a new QueryHints object with the given hint. The associated + value is the hint object itself.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if hint is null</dd></dl> +</li> +</ul> +<a name="with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> with(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</pre> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if hint or value is null</dd></dl> +</li> +</ul> +<a name="without(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>without</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> without(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</li> +</ul> +<a name="contains(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns false if hint is not provided.</div> +</li> +</ul> +<a name="get(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.Object get(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns null if hint is not provided.</div> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<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 boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/QueryHints.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/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface 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/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html new file mode 100644 index 0000000..761a4ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html @@ -0,0 +1,238 @@ +<!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>RepositoryAccess (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="RepositoryAccess (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/RepositoryAccess.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/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.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/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface RepositoryAccess" class="title">Interface RepositoryAccess</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">RepositoryAccess</span></pre> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</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"> +<!-- ========== 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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#getRootRepository()">getRootRepository</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getRootRepository()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootRepository</h4> +<pre><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> getRootRepository()</pre> +</li> +</ul> +<a name="storageAccessFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storageAccessFor</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S> storageAccessFor(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>specific type of StorageAccess instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if specified type is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if specified type is not suitable</dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RepositoryAccess.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/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.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/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..628115a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,296 @@ +<!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>SortedQueryExecutor.ArraySortSupport (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="SortedQueryExecutor.ArraySortSupport (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/SortedQueryExecutor.ArraySortSupport.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/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.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/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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 SortedQueryExecutor.ArraySortSupport" class="title">Class SortedQueryExecutor.ArraySortSupport<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.SortedQueryExecutor.ArraySortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">SortedQueryExecutor.ArraySortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/SortedQueryExecutor.ArraySortSupport.html#SortedQueryExecutor.ArraySortSupport()">SortedQueryExecutor.ArraySortSupport</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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Returns a new ArraySortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new ArraySortBuffer.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="SortedQueryExecutor.ArraySortSupport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedQueryExecutor.ArraySortSupport</h4> +<pre>public SortedQueryExecutor.ArraySortSupport()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>> createSortBuffer()</pre> +<div class="block">Returns a new ArraySortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">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="createSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>> createSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Returns a new ArraySortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">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></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/SortedQueryExecutor.ArraySortSupport.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/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.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/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..c5b2888 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,296 @@ +<!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>SortedQueryExecutor.MergeSortSupport (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="SortedQueryExecutor.MergeSortSupport (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/SortedQueryExecutor.MergeSortSupport.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/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface 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/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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 SortedQueryExecutor.MergeSortSupport" class="title">Class SortedQueryExecutor.MergeSortSupport<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.SortedQueryExecutor.MergeSortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">SortedQueryExecutor.MergeSortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/SortedQueryExecutor.MergeSortSupport.html#SortedQueryExecutor.MergeSortSupport()">SortedQueryExecutor.MergeSortSupport</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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Returns a new MergeSortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new MergeSortBuffer.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="SortedQueryExecutor.MergeSortSupport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedQueryExecutor.MergeSortSupport</h4> +<pre>public SortedQueryExecutor.MergeSortSupport()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>> createSortBuffer()</pre> +<div class="block">Returns a new MergeSortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">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="createSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>> createSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Returns a new MergeSortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">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></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/SortedQueryExecutor.MergeSortSupport.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/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface 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/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..714d83d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html @@ -0,0 +1,241 @@ +<!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>SortedQueryExecutor.Support (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="SortedQueryExecutor.Support (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/SortedQueryExecutor.Support.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/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface SortedQueryExecutor.Support" class="title">Interface SortedQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">SortedQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>> createSortBuffer()</pre> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</li> +</ul> +<a name="createSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>> createSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Implementation must return an empty buffer for sorting.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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/SortedQueryExecutor.Support.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/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html new file mode 100644 index 0000000..9f616f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html @@ -0,0 +1,494 @@ +<!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>SortedQueryExecutor (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="SortedQueryExecutor (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/SortedQueryExecutor.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/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.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/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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 SortedQueryExecutor" class="title">Class SortedQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.SortedQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SortedQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</code></a></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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</td> +</tr> +</table> +</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/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</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/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Prints native query of the wrapped executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedQueryExecutor</h4> +<pre>public SortedQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - optional support to control sort buffer; if null, array is used</dd><dd><code>executor</code> - executor to wrap</dd><dd><code>handledOrdering</code> - optional handled ordering</dd><dd><code>remainderOrdering</code> - required remainder ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if executor is null or if + remainder ordering is empty</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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">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/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <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 class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">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/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints native query of the wrapped executor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">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/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</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(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/SortedQueryExecutor.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/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.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/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/StandardQuery.html new file mode 100644 index 0000000..51544d0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQuery.html @@ -0,0 +1,1368 @@ +<!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>StandardQuery (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="StandardQuery (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/StandardQuery.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/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.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/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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 StandardQuery" class="title">Class StandardQuery<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.StandardQuery<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 abstract class <span class="strong">StandardQuery<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> +implements <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</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/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/StandardQuery.html" title="type parameter in StandardQuery">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 "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()">clearExecutor</a></strong>()</code> +<div class="block">Clears any cached reference to a query executor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#count()">count</a></strong>()</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#deleteAll()">deleteAll</a></strong>()</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#executor()">executor</a></strong>()</code> +<div class="block">Returns the executor in use by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#executorFactory()">executorFactory</a></strong>()</code> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#exists()">exists</a></strong>()</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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">Returns true if any results are matched by this query.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch()">fetch</a></strong>()</code> +<div class="block">Fetches results for this query.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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">Fetches results for this query.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code> +<div class="block">Returns the amount of blank parameters that need to be filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the query's filter.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#not()">not</a></strong>()</code> +<div class="block">Returns a new query which produces all the results not supplied in this + query.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/StandardQuery.html" title="type parameter in StandardQuery">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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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/StandardQuery.html#printNative(java.lang.Appendable, int)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Prints the native query to any appendable, 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/StandardQuery.html#printPlan(java.lang.Appendable, int)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel)</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>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#queryFactory()">queryFactory</a></strong>()</code> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()">resetExecutor</a></strong>()</code> +<div class="block">Resets any cached reference to a query executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()">setExecutor</a></strong>()</code> +<div class="block">Ensures that a cached query executor reference is available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.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">Deletes zero or one matching objects.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Returns a copy of this Query with the next blank parameters filled 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#deleteOne()">deleteOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</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="StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StandardQuery</h4> +<pre>protected StandardQuery(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</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/StandardQuery.html" title="type parameter in StandardQuery">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> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">getStorableType</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/StandardQuery.html" title="type parameter in StandardQuery">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="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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getFilter()">Query</a></code></strong></div> +<div class="block">Returns the query's filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</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/StandardQuery.html" title="type parameter in StandardQuery">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="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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getFilterValues()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getFilterValues()">Query</a></code></strong></div> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</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/StandardQuery.html" title="type parameter in StandardQuery">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="getBlankParameterCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlankParameterCount</h4> +<pre>public int getBlankParameterCount()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">Query</a></code></strong></div> +<div class="block">Returns the amount of blank parameters that need to be filled in. If + zero, then this query is ready to be used.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount</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/StandardQuery.html" title="type parameter in StandardQuery">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="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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(int value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(int)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(int)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(long value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(long)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(long)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(float value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(float)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(float)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(double value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(double)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(double)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(boolean value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(char value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(char)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(char)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(byte value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(byte)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(byte)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(short value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(short)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(short)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(java.lang.Object value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> withValues(java.lang.Object... values)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">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/StandardQuery.html" title="type parameter in StandardQuery">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#and(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 "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(com.amazon.carbonado.filter.Filter)">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/StandardQuery.html" title="type parameter in StandardQuery">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</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(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/StandardQuery.html" title="type parameter in StandardQuery">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/StandardQuery.html" title="type parameter in StandardQuery">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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">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/StandardQuery.html" title="type parameter in StandardQuery">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</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> not() + 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#not()">Query</a></code></strong></div> +<div class="block">Returns a new query which produces all the results not supplied in this + query. Any filled in parameters in this query are copied into the new + one.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#not()">not</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/StandardQuery.html" title="type parameter in StandardQuery">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/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/StandardQuery.html" title="type parameter in StandardQuery">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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</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/StandardQuery.html" title="type parameter in StandardQuery">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>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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> after(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#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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#after(T)">after</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/StandardQuery.html" title="type parameter in StandardQuery">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, this query is + returned</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="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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetch() + 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#fetch()">Query</a></code></strong></div> +<div class="block">Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetch()">fetch</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/StandardQuery.html" title="type parameter in StandardQuery">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>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></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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetch(<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#fetch(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</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/StandardQuery.html" title="type parameter in StandardQuery">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>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></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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetchSlice(long from, + java.lang.Long to) + 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#fetchSlice(long, java.lang.Long)">Query</a></code></strong></div> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</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/StandardQuery.html" title="type parameter in StandardQuery">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>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> +<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="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/StandardQuery.html" title="type parameter in StandardQuery">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) + 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#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</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/StandardQuery.html" title="type parameter in StandardQuery">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>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> +<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="tryDeleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne() + 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#tryDeleteOne()">Query</a></code></strong></div> +<div class="block">Deletes zero or one matching objects. If the number of matching records + 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#tryDeleteOne()">tryDeleteOne</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/StandardQuery.html" title="type parameter in StandardQuery">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>true if record existed and was deleted, or false if no match</dd> +<dt><span class="strong">Throws:</span></dt> +<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="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) + 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#tryDeleteOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Deletes zero or one matching objects. If the number of matching records + 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#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</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/StandardQuery.html" title="type parameter in StandardQuery">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>true if record existed and was deleted, or false if no match</dd> +<dt><span class="strong">Throws:</span></dt> +<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="deleteAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll() + 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#deleteAll()">Query</a></code></strong></div> +<div class="block">Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</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/StandardQuery.html" title="type parameter in StandardQuery">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/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</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) + 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#deleteAll(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</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/StandardQuery.html" title="type parameter in StandardQuery">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/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count() + 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#count()">Query</a></code></strong></div> +<div class="block">Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#count()">count</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/StandardQuery.html" title="type parameter in StandardQuery">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>count of matches</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="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) + 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#count(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</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/StandardQuery.html" title="type parameter in StandardQuery">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>count of matches</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="exists()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists() + 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#exists()">Query</a></code></strong></div> +<div class="block">Returns true if any results are matched by this query.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#exists()">exists</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/StandardQuery.html" title="type parameter in StandardQuery">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>true if any matches</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="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) + 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#exists(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Returns true if any results are matched by this query.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</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/StandardQuery.html" title="type parameter in StandardQuery">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>true if any matches</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="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) + 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, int)">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, int)">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/StandardQuery.html" title="type parameter in StandardQuery">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><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> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></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) + 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, int)">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, int)">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/StandardQuery.html" title="type parameter in StandardQuery">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><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> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></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/StandardQuery.html" title="type parameter in StandardQuery">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/StandardQuery.html" title="type parameter in StandardQuery">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="blockList"> +<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/StandardQuery.html" title="type parameter in StandardQuery">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/StandardQuery.html" title="type parameter in StandardQuery">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="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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<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="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getOrdering()</pre> +</li> +</ul> +<a name="executor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executor</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> executor() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns the executor in use by this query.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="setExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutor</h4> +<pre>protected void setExecutor() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Ensures that a cached query executor reference is available. If not, the + query executor factory is called and the executor is cached.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="resetExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetExecutor</h4> +<pre>protected void resetExecutor() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Resets any cached reference to a query executor. If a reference is + available, it is replaced, but a clear reference is not set.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="clearExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearExecutor</h4> +<pre>protected void clearExecutor()</pre> +<div class="block">Clears any cached reference to a query executor. The next time this + Query is used, it will get an executor from the query executor factory + and cache a reference to it.</div> +</li> +</ul> +<a name="enterTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired isolation level</dd></dl> +</li> +</ul> +<a name="queryFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>queryFactory</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> queryFactory()</pre> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</li> +</ul> +<a name="executorFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executorFactory</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> executorFactory()</pre> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</li> +</ul> +<a name="newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>newInstance</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> newInstance(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values. The Filter in the FilterValues is the same as was + passed in the constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - non-null values object</dd><dd><code>ordering</code> - order-by properties, never null</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/StandardQuery.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/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.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/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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> diff --git a/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html new file mode 100644 index 0000000..d26bbc1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html @@ -0,0 +1,535 @@ +<!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>StandardQueryFactory (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="StandardQueryFactory (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/StandardQueryFactory.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/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.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/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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 StandardQueryFactory" class="title">Class StandardQueryFactory<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.StandardQueryFactory<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/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">StandardQueryFactory<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/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S></pre> +<div class="block">Builds and caches StandardQuery instances.</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"> +<!-- ======== 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/StandardQueryFactory.html#StandardQueryFactory(java.lang.Class)">StandardQueryFactory</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#StandardQueryFactory(java.lang.Class, boolean)">StandardQueryFactory</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type, + boolean lazySetExecutor)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#clearExecutors()">clearExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()"><code>StandardQuery.clearExecutor()</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#getStorableType()">getStorableType</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query</a></strong>()</code> +<div class="block">Returns a new or cached query that fetches everything.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter)</code> +<div class="block">Returns a new or cached query for the given filter.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#resetExecutors()">resetExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()"><code>StandardQuery.resetExecutor()</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#setExecutors()">setExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()"><code>StandardQuery.setExecutor()</code></a>.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="StandardQueryFactory(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StandardQueryFactory</h4> +<pre>protected StandardQueryFactory(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type)</pre> +</li> +</ul> +<a name="StandardQueryFactory(java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StandardQueryFactory</h4> +<pre>protected StandardQueryFactory(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type, + boolean lazySetExecutor)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lazySetExecutor</code> - by default, query executors are built and set + eagerly. Pass true to build and set executor on first query use.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">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="query()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query that fetches everything.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(java.lang.String filter) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given filter.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given filter.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</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></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">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> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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></dd></dl> +</li> +</ul> +<a name="setExecutors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutors</h4> +<pre>public void setExecutors() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()"><code>StandardQuery.setExecutor()</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="resetExecutors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetExecutors</h4> +<pre>public void resetExecutors() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()"><code>StandardQuery.resetExecutor()</code></a>. + This call can be used to rebuild all cached query plans after the set of + available indexes has changed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="clearExecutors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearExecutors</h4> +<pre>public void clearExecutors()</pre> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()"><code>StandardQuery.clearExecutor()</code></a>. + This call can be used to clear all cached query plans after the set of + available indexes has changed.</div> +</li> +</ul> +<a name="createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createQuery</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> createQuery(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Implement this method to return query implementations.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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></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/StandardQueryFactory.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/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.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/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html new file mode 100644 index 0000000..cfec807 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html @@ -0,0 +1,565 @@ +<!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>StorableIndexSet (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="StorableIndexSet (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/StorableIndexSet.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/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface 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/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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 StorableIndexSet" class="title">Class StorableIndexSet<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>java.util.AbstractCollection<E></li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractSet<E></li> +<li> +<ul class="inheritance"> +<li>java.util.TreeSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.StorableIndexSet<S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.Collection<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.NavigableSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.Set<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.SortedSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorableIndexSet<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.util.TreeSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>></pre> +<div class="block">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.amazon.carbonado.qe.StorableIndexSet">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/StorableIndexSet.html#StorableIndexSet()">StorableIndexSet</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">StorableIndexSet</a></strong>(<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> set)</code> +<div class="block">Copy constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">addAlternateKeys</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo)">addIndexes</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)">addKey</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">addPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Finds the best index to represent the given key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Finds the best index to represent the primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#markClustered(boolean)">markClustered</a></strong>(boolean clustered)</code> +<div class="block">Marks all indexes as clustered or non-clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce()">reduce</a></strong>()</code> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce(com.amazon.carbonado.info.Direction)">reduce</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Set the default direction for all index properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.TreeSet"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.TreeSet</h3> +<code>add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, subSet, subSet, tailSet, tailSet</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractSet"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractSet</h3> +<code>equals, hashCode, removeAll</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractCollection</h3> +<code>containsAll, retainAll, toArray, toArray, toString</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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Set"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Set</h3> +<code>containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray</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="StorableIndexSet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndexSet</h4> +<pre>public StorableIndexSet()</pre> +</li> +</ul> +<a name="StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableIndexSet</h4> +<pre>public StorableIndexSet(<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> set)</pre> +<div class="block">Copy constructor.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addIndexes(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndexes</h4> +<pre>public void addIndexes(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Adds all the indexes of the given storable.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndexes</h4> +<pre>public void addIndexes(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</pre> +<div class="block">Adds all the indexes of the given storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - default ordering direction to apply to each + index property</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null</dd></dl> +</li> +</ul> +<a name="addAlternateKeys(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAlternateKeys</h4> +<pre>public void addAlternateKeys(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="addPrimaryKey(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPrimaryKey</h4> +<pre>public void addPrimaryKey(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>. This method should not be called if the primary key + cannot be altered because persistent data is already stored against + it. Instead, the primary key index should be added as a normal index. + + <p>After adding the primary key via this method and after reducing the + set, call <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)"><code>findPrimaryKeyIndex</code></a> to get the + best index to represent the primary key.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="addKey(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addKey</h4> +<pre>public void addKey(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</pre> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null</dd></dl> +</li> +</ul> +<a name="reduce()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public void reduce()</pre> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</li> +</ul> +<a name="reduce(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public void reduce(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</pre> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - replace unspecified property directions with this</dd></dl> +</li> +</ul> +<a name="setDefaultDirection(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultDirection</h4> +<pre>public void setDefaultDirection(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</pre> +<div class="block">Set the default direction for all index properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - replace unspecified property directions with this</dd></dl> +</li> +</ul> +<a name="markClustered(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markClustered</h4> +<pre>public void markClustered(boolean clustered)</pre> +<div class="block">Marks all indexes as clustered or non-clustered.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clustered</code> - true to mark clustered; false to mark non-clustered</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isClustered()"><code>StorableIndex.isClustered()</code></a></dd></dl> +</li> +</ul> +<a name="uniquify(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uniquify</h4> +<pre>public void uniquify(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="uniquify(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uniquify</h4> +<pre>public void uniquify(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</pre> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null</dd></dl> +</li> +</ul> +<a name="findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findPrimaryKeyIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> findPrimaryKeyIndex(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Finds the best index to represent the primary key. Should be called + after calling reduce. As long as the primary key was added via <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)"><code>addPrimaryKey</code></a>, this method should never return null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="findKeyIndex(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>findKeyIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> findKeyIndex(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</pre> +<div class="block">Finds the best index to represent the given key. Should be called after + calling reduce. As long as the key was added via <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>, + this method should never return null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null</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/StorableIndexSet.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/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface 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/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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> diff --git a/apidocs/com/amazon/carbonado/qe/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/StorageAccess.html new file mode 100644 index 0000000..affde1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorageAccess.html @@ -0,0 +1,305 @@ +<!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>StorageAccess (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="StorageAccess (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/StorageAccess.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/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.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/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface StorageAccess" class="title">Interface StorageAccess<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorageAccess<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/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></pre> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</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"> +<!-- ========== 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>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#getAllIndexes()">getAllIndexes</a></strong>()</code> +<div class="block">Returns all the available indexes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#getQueryExecutorFactory()">getQueryExecutorFactory</a></strong>()</code> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#storageDelegate(com.amazon.carbonado.info.StorableIndex)">storageDelegate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</code> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.FullScanQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll()">countAll</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.KeyQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.IndexedQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.SortedQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> getStorableType()</pre> +<div class="block">Returns the specific type of Storable managed by this object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">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="getQueryExecutorFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueryExecutorFactory</h4> +<pre><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> getQueryExecutorFactory()</pre> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</li> +</ul> +<a name="getAllIndexes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllIndexes</h4> +<pre>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>>> getAllIndexes()</pre> +<div class="block">Returns all the available indexes.</div> +</li> +</ul> +<a name="storageDelegate(com.amazon.carbonado.info.StorableIndex)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storageDelegate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> storageDelegate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</pre> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated. Return the storage to delegate to or null if index should + not be delegated.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is unknown</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/StorageAccess.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/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.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/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..faf0d05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html @@ -0,0 +1,271 @@ +<!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>UnionQueryAnalyzer.Result (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="UnionQueryAnalyzer.Result (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/UnionQueryAnalyzer.Result.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/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.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/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 UnionQueryAnalyzer.Result" class="title">Class UnionQueryAnalyzer.Result</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.UnionQueryAnalyzer.Result</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionQueryAnalyzer.Result</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getSubResults()">getSubResults</a></strong>()</code> +<div class="block">Returns results for each sub-query to be executed in the union.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getTotalOrdering()">getTotalOrdering</a></strong>()</code> +<div class="block">Returns a total ordering, if one was imposed.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSubResults()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubResults</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>> getSubResults()</pre> +<div class="block">Returns results for each sub-query to be executed in the union. If + only one result is returned, then no union needs to be performed.</div> +</li> +</ul> +<a name="getTotalOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> getTotalOrdering()</pre> +<div class="block">Returns a total ordering, if one was imposed. Otherwise, null is returned.</div> +</li> +</ul> +<a name="createExecutor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createExecutor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> createExecutor() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Creates a QueryExecutor based on this result.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/UnionQueryAnalyzer.Result.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/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.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/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html new file mode 100644 index 0000000..e797763 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html @@ -0,0 +1,350 @@ +<!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>UnionQueryAnalyzer (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="UnionQueryAnalyzer (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/UnionQueryAnalyzer.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/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.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/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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><a href="#nested_class_summary">Nested</a> | </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 UnionQueryAnalyzer" class="title">Class UnionQueryAnalyzer<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.UnionQueryAnalyzer<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionQueryAnalyzer<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries. If necessary, the UnionQueryAnalyzer will alter + the query slightly, imposing a total ordering. Internally, an <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryAnalyzer</code></a> is used for selecting the best indexes. + + <p>UnionQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.</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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></strong></code> </td> +</tr> +</table> +</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/UnionQueryAnalyzer.html#UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">UnionQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</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/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#getStorableType()">getStorableType</a></strong>()</code> </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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnionQueryAnalyzer</h4> +<pre>public UnionQueryAnalyzer(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable being queried</dd><dd><code>access</code> - repository access for examing available indexes</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type or indexProvider is null</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">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="analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>analyze</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a> analyze(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter which must be <a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()"><code>bound</code></a></dd><dd><code>ordering</code> - optional properties which define desired ordering</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">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> - optional filter which must be <a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()"><code>bound</code></a></dd><dd><code>ordering</code> - optional properties which define desired ordering</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/UnionQueryAnalyzer.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/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.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/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html new file mode 100644 index 0000000..222a230 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html @@ -0,0 +1,434 @@ +<!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>UnionQueryExecutor (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="UnionQueryExecutor (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/UnionQueryExecutor.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/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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 UnionQueryExecutor" class="title">Class UnionQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.UnionQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionQueryExecutor<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/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><code>UnionCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)">UnionQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>... executors)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</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/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<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/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the combined filter of the wrapped executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Prints native queries of the wrapped executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UnionQueryExecutor</h4> +<pre>public UnionQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>... executors)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executors</code> - executors to wrap, each must have the exact same total ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or if ordering doesn't match</dd></dl> +</li> +</ul> +<a name="UnionQueryExecutor(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UnionQueryExecutor</h4> +<pre>public UnionQueryExecutor(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executors</code> - executors to wrap, each must have the exact same total ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any executors is null or if ordering doesn't match</dd></dl> +</li> +</ul> +<a name="UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnionQueryExecutor</h4> +<pre>public UnionQueryExecutor(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executors</code> - executors to wrap, each must have the exact same total ordering</dd><dd><code>totalOrdering</code> - effective total ordering of executors</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if executors is null</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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</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/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, 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/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</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/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns the combined filter of the wrapped executors.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints native queries of the wrapped executors.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">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/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</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(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</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> +</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/UnionQueryExecutor.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/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html new file mode 100644 index 0000000..567b706 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.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="Uses of Class com.amazon.carbonado.qe.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><a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.AbstractQuery" class="title">Uses of Class<br>com.amazon.carbonado.qe.AbstractQuery</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Abstract query implementation which uses a <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html new file mode 100644 index 0000000..ac33f84 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html @@ -0,0 +1,205 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.AbstractQueryExecutor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html new file mode 100644 index 0000000..e9e0f72 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html @@ -0,0 +1,206 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.BoundaryType (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="Uses of Class com.amazon.carbonado.qe.BoundaryType (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><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.BoundaryType" class="title">Uses of Class<br>com.amazon.carbonado.qe.BoundaryType</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></code></td> +<td class="colLast"><span class="strong">BoundaryType.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>[]</code></td> +<td class="colLast"><span class="strong">BoundaryType.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></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> +<tbody> +<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/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</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/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html new file mode 100644 index 0000000..02be73d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html @@ -0,0 +1,275 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.CompositeScore (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="Uses of Class com.amazon.carbonado.qe.CompositeScore (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><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.CompositeScore" class="title">Uses of Class<br>com.amazon.carbonado.qe.CompositeScore</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getCompositeScore()">getCompositeScore</a></strong>()</code> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</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/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</code> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</code> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator()">localForeignComparator</a></strong>()</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)">canMergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</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/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html new file mode 100644 index 0000000..cc4d958 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.DelegatedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.DelegatedQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..48f311a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory (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="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory (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><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory" class="title">Uses of Class<br>com.amazon.carbonado.qe.DelegatedQueryExecutorFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.DelegatedQueryExecutorFactory</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html new file mode 100644 index 0000000..63377f7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.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="Uses of Class com.amazon.carbonado.qe.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><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.EmptyQuery" class="title">Uses of Class<br>com.amazon.carbonado.qe.EmptyQuery</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.EmptyQuery</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html new file mode 100644 index 0000000..541d205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.FilteredQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.FilteredQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html new file mode 100644 index 0000000..1ef2837 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html @@ -0,0 +1,246 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.FilteringScore (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="Uses of Class com.amazon.carbonado.qe.FilteringScore (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><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.FilteringScore" class="title">Uses of Class<br>com.amazon.carbonado.qe.FilteringScore</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#getFilteringScore()">getFilteringScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</code> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which FilteringScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#rangeComparator()">rangeComparator</a></strong>()</code> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">canMergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</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/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..68b5038 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html @@ -0,0 +1,173 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.FullScanQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)">FullScanQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> support)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html new file mode 100644 index 0000000..b7289bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.FullScanQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.FullScanQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..ec724a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,225 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result (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="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result" class="title">Uses of Class<br>com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainderFilter(com.amazon.carbonado.filter.Filter)">mergeRemainderFilter</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</code> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</code> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</code> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getSubResults()">getSubResults</a></strong>()</code> +<div class="block">Returns results for each sub-query to be executed in the union.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">canMergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..569b053 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer (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="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer" class="title">Uses of Class<br>com.amazon.carbonado.qe.IndexedQueryAnalyzer</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.IndexedQueryAnalyzer</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..da34597 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html @@ -0,0 +1,175 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.IndexedQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html new file mode 100644 index 0000000..67102f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.IndexedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.IndexedQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html new file mode 100644 index 0000000..be08715 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.IterableQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.IterableQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html new file mode 100644 index 0000000..d013501 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.JoinedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.JoinedQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..4007aa1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html @@ -0,0 +1,175 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.KeyQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html new file mode 100644 index 0000000..4775511 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.KeyQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.KeyQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html new file mode 100644 index 0000000..87365a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html @@ -0,0 +1,577 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.OrderingList (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="Uses of Class com.amazon.carbonado.qe.OrderingList (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><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.OrderingList" class="title">Uses of Class<br>com.amazon.carbonado.qe.OrderingList</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(java.lang.Class, java.lang.String)">concat</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> type, + java.lang.String property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</code> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#emptyList()">emptyList</a></strong>()</code> +<div class="block">Returns a canonical empty instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get</a></strong>(java.lang.Class<S> type, + java.lang.String... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get</a></strong>(java.lang.Class<S> type, + java.lang.String property)</code> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getFreeOrdering()">getFreeOrdering</a></strong>()</code> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getHandledOrdering()">getHandledOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index supports.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index does not + support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Remainder orderings which override that in composite score.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getTotalOrdering()">getTotalOrdering</a></strong>()</code> +<div class="block">Returns a total ordering, if one was imposed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getUnusedOrdering()">getUnusedOrdering</a></strong>()</code> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#reduce()">reduce</a></strong>()</code> +<div class="block">Eliminates redundant ordering properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace</a></strong>(int index, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list with the given element replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#reverseDirections()">reverseDirections</a></strong>()</code> +<div class="block">Returns this list with all orderings in reverse.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#subList(int, int)">subList</a></strong>(int fromIndex, + int toIndex)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</code> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter 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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</code> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</code> +<div class="block">Returns a new OrderingScore with the remainder replaced.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</code> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><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="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html new file mode 100644 index 0000000..6d59339 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html @@ -0,0 +1,226 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.OrderingScore (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="Uses of Class com.amazon.carbonado.qe.OrderingScore (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><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.OrderingScore" class="title">Uses of Class<br>com.amazon.carbonado.qe.OrderingScore</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#getOrderingScore()">getOrderingScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</code> +<div class="block">Returns a new OrderingScore with the remainder replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><?>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which OrderingScores are + better.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">canMergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html new file mode 100644 index 0000000..0d3242b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryEngine (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="Uses of Class com.amazon.carbonado.qe.QueryEngine (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><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryEngine" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryEngine</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.QueryEngine</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html new file mode 100644 index 0000000..2a62831 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html @@ -0,0 +1,331 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.QueryExecutor (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="Uses of Interface com.amazon.carbonado.qe.QueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.QueryExecutor" class="title">Uses of Interface<br>com.amazon.carbonado.qe.QueryExecutor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#executor()">executor</a></strong>()</code> +<div class="block">Returns the executor in use by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)">FilteredQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)">UnionQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>... executors)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructor parameters in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html new file mode 100644 index 0000000..518abde --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryExecutorCache (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="Uses of Class com.amazon.carbonado.qe.QueryExecutorCache (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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryExecutorCache" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryExecutorCache</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.QueryExecutorCache</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html new file mode 100644 index 0000000..eb00e23 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html @@ -0,0 +1,213 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory (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="Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory (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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory" class="title">Uses of Interface<br>com.amazon.carbonado.qe.QueryExecutorFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#executorFactory()">executorFactory</a></strong>()</code> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html#getQueryExecutorFactory()">getQueryExecutorFactory</a></strong>()</code> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)">QueryExecutorCache</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> factory)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html new file mode 100644 index 0000000..398b758 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html @@ -0,0 +1,202 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.QueryFactory (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="Uses of Interface com.amazon.carbonado.qe.QueryFactory (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><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.QueryFactory" class="title">Uses of Interface<br>com.amazon.carbonado.qe.QueryFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Builds and caches StandardQuery instances.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#queryFactory()">queryFactory</a></strong>()</code> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><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="colLast"><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="colLast"><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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html new file mode 100644 index 0000000..6e78e09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html @@ -0,0 +1,208 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryHint (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="Uses of Class com.amazon.carbonado.qe.QueryHint (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><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryHint" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryHint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></code></td> +<td class="colLast"><span class="strong">QueryHint.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>[]</code></td> +<td class="colLast"><span class="strong">QueryHint.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#contains(com.amazon.carbonado.qe.QueryHint)">contains</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns false if hint is not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns null if hint is not provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html new file mode 100644 index 0000000..fce4f14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html @@ -0,0 +1,325 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryHints (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="Uses of Class com.amazon.carbonado.qe.QueryHints (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><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryHints" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryHints</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#emptyHints()">emptyHints</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</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/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</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/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html new file mode 100644 index 0000000..b4d2d7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html @@ -0,0 +1,186 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.RepositoryAccess (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="Uses of Interface com.amazon.carbonado.qe.RepositoryAccess (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><a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.RepositoryAccess" class="title">Uses of Interface<br>com.amazon.carbonado.qe.RepositoryAccess</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">IndexedQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> type, + <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">QueryEngine</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> type, + <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">UnionQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> type, + <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..e98b2ea --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport (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="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport" class="title">Uses of Class<br>com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..b2fe180 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport (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="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport" class="title">Uses of Class<br>com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..5551e27 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html @@ -0,0 +1,193 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.SortedQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html new file mode 100644 index 0000000..b2bec2a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.SortedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.SortedQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html new file mode 100644 index 0000000..2daf639 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html @@ -0,0 +1,180 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.StandardQuery (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="Uses of Class com.amazon.carbonado.qe.StandardQuery (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><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.StandardQuery" class="title">Uses of Class<br>com.amazon.carbonado.qe.StandardQuery</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</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/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html new file mode 100644 index 0000000..0c1b2d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.StandardQueryFactory (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="Uses of Class com.amazon.carbonado.qe.StandardQueryFactory (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><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.StandardQueryFactory" class="title">Uses of Class<br>com.amazon.carbonado.qe.StandardQueryFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html new file mode 100644 index 0000000..5de3c10 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.StorableIndexSet (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="Uses of Class com.amazon.carbonado.qe.StorableIndexSet (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><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.StorableIndexSet" class="title">Uses of Class<br>com.amazon.carbonado.qe.StorableIndexSet</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">StorableIndexSet</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> set)</code> +<div class="block">Copy constructor.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html new file mode 100644 index 0000000..a2df0e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.StorageAccess (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="Uses of Interface com.amazon.carbonado.qe.StorageAccess (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><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.StorageAccess" class="title">Uses of Interface<br>com.amazon.carbonado.qe.StorageAccess</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><span class="strong">RepositoryAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..8c63925 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result (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="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result (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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result" class="title">Uses of Class<br>com.amazon.carbonado.qe.UnionQueryAnalyzer.Result</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</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/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html new file mode 100644 index 0000000..3e54a03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer (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="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer (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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer" class="title">Uses of Class<br>com.amazon.carbonado.qe.UnionQueryAnalyzer</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.UnionQueryAnalyzer</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html new file mode 100644 index 0000000..0d3b9cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.UnionQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.UnionQueryExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/package-frame.html b/apidocs/com/amazon/carbonado/qe/package-frame.html new file mode 100644 index 0000000..e951eaa --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-frame.html @@ -0,0 +1,63 @@ +<!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>com.amazon.carbonado.qe (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/qe/package-summary.html" target="classFrame">com.amazon.carbonado.qe</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>FullScanQueryExecutor.Support</i></a></li> +<li><a href="IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>IndexedQueryExecutor.Support</i></a></li> +<li><a href="KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>KeyQueryExecutor.Support</i></a></li> +<li><a href="QueryExecutor.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>QueryExecutor</i></a></li> +<li><a href="QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>QueryExecutorFactory</i></a></li> +<li><a href="QueryFactory.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>QueryFactory</i></a></li> +<li><a href="RepositoryAccess.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>RepositoryAccess</i></a></li> +<li><a href="SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>SortedQueryExecutor.Support</i></a></li> +<li><a href="StorageAccess.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>StorageAccess</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractQuery.html" title="class in com.amazon.carbonado.qe" target="classFrame">AbstractQuery</a></li> +<li><a href="AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">AbstractQueryExecutor</a></li> +<li><a href="CompositeScore.html" title="class in com.amazon.carbonado.qe" target="classFrame">CompositeScore</a></li> +<li><a href="DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">DelegatedQueryExecutor</a></li> +<li><a href="DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe" target="classFrame">DelegatedQueryExecutorFactory</a></li> +<li><a href="EmptyQuery.html" title="class in com.amazon.carbonado.qe" target="classFrame">EmptyQuery</a></li> +<li><a href="FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">FilteredQueryExecutor</a></li> +<li><a href="FilteringScore.html" title="class in com.amazon.carbonado.qe" target="classFrame">FilteringScore</a></li> +<li><a href="FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">FullScanQueryExecutor</a></li> +<li><a href="IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe" target="classFrame">IndexedQueryAnalyzer</a></li> +<li><a href="IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">IndexedQueryExecutor</a></li> +<li><a href="IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">IterableQueryExecutor</a></li> +<li><a href="JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">JoinedQueryExecutor</a></li> +<li><a href="KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">KeyQueryExecutor</a></li> +<li><a href="OrderingList.html" title="class in com.amazon.carbonado.qe" target="classFrame">OrderingList</a></li> +<li><a href="OrderingScore.html" title="class in com.amazon.carbonado.qe" target="classFrame">OrderingScore</a></li> +<li><a href="QueryEngine.html" title="class in com.amazon.carbonado.qe" target="classFrame">QueryEngine</a></li> +<li><a href="QueryExecutorCache.html" title="class in com.amazon.carbonado.qe" target="classFrame">QueryExecutorCache</a></li> +<li><a href="QueryHints.html" title="class in com.amazon.carbonado.qe" target="classFrame">QueryHints</a></li> +<li><a href="SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">SortedQueryExecutor</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe" target="classFrame">SortedQueryExecutor.ArraySortSupport</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe" target="classFrame">SortedQueryExecutor.MergeSortSupport</a></li> +<li><a href="StandardQuery.html" title="class in com.amazon.carbonado.qe" target="classFrame">StandardQuery</a></li> +<li><a href="StandardQueryFactory.html" title="class in com.amazon.carbonado.qe" target="classFrame">StandardQueryFactory</a></li> +<li><a href="StorableIndexSet.html" title="class in com.amazon.carbonado.qe" target="classFrame">StorableIndexSet</a></li> +<li><a href="UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe" target="classFrame">UnionQueryAnalyzer</a></li> +<li><a href="UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">UnionQueryExecutor</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="BoundaryType.html" title="enum in com.amazon.carbonado.qe" target="classFrame">BoundaryType</a></li> +<li><a href="QueryHint.html" title="enum in com.amazon.carbonado.qe" target="classFrame">QueryHint</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/qe/package-summary.html b/apidocs/com/amazon/carbonado/qe/package-summary.html new file mode 100644 index 0000000..94c9d2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-summary.html @@ -0,0 +1,398 @@ +<!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>com.amazon.carbonado.qe (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="com.amazon.carbonado.qe (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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/lob/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package com.amazon.carbonado.qe</h1> +<div class="docSummary"> +<div class="block">Support for implementing a Query Engine.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Performs all the actual work of executing a query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></td> +<td class="colLast"> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Evaluates an index for how well it matches a query's desired filtering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Analyzes a simple query specification and determines which index is best + suited for its execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Evaluates an index for how well it matches a query's desired ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></td> +<td class="colLast"> +<div class="block">An immutable map of query hints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Builds and caches StandardQuery instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></td> +<td class="colLast"> +<div class="block">Describes a value range boundary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></td> +<td class="colLast"> +<div class="block">Defines a hint key.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.qe Description">Package com.amazon.carbonado.qe Description</h2> +<div class="block">Support for implementing a Query Engine. Repositories are free to use this + package to aid in their implementation, but user-level applications have no + need to use this package.</div> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/lob/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/package-tree.html b/apidocs/com/amazon/carbonado/qe/package-tree.html new file mode 100644 index 0000000..a256965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-tree.html @@ -0,0 +1,223 @@ +<!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>com.amazon.carbonado.qe Class Hierarchy (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="com.amazon.carbonado.qe Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/lob/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package com.amazon.carbonado.qe</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.util.AbstractCollection<E> (implements java.util.Collection<E>) +<ul> +<li type="circle">java.util.AbstractList<E> (implements java.util.List<E>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">OrderingList</span></a><S> (implements java.io.Serializable)</li> +</ul> +</li> +<li type="circle">java.util.AbstractSet<E> (implements java.util.Set<E>) +<ul> +<li type="circle">java.util.TreeSet<E> (implements java.lang.Cloneable, java.util.NavigableSet<E>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">StorableIndexSet</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">AbstractQuery</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">EmptyQuery</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">StandardQuery</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">AbstractQueryExecutor</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">FilteredQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">FullScanQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IterableQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">JoinedQueryExecutor</span></a><S,T></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">KeyQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryExecutor</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">CompositeScore</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">DelegatedQueryExecutor</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">DelegatedQueryExecutorFactory</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">FilteringScore</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer.Result</span></a></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">OrderingScore</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryExecutorCache</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryHints</span></a> (implements java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.ArraySortSupport</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.MergeSortSupport</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">StandardQueryFactory</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryEngine</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer.Result</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">FullScanQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">KeyQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutorFactory</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryFactory</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">RepositoryAccess</span></a></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>)</li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">QueryHint</span></a></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">BoundaryType</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/lob/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<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> diff --git a/apidocs/com/amazon/carbonado/qe/package-use.html b/apidocs/com/amazon/carbonado/qe/package-use.html new file mode 100644 index 0000000..d198fbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-use.html @@ -0,0 +1,265 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.qe (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="Uses of Package com.amazon.carbonado.qe (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package com.amazon.carbonado.qe" class="title">Uses of Package<br>com.amazon.carbonado.qe</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/AbstractQuery.html#com.amazon.carbonado.qe">AbstractQuery</a> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html#com.amazon.carbonado.qe">AbstractQueryExecutor</a> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/BoundaryType.html#com.amazon.carbonado.qe">BoundaryType</a> +<div class="block">Describes a value range boundary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/CompositeScore.html#com.amazon.carbonado.qe">CompositeScore</a> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/FilteringScore.html#com.amazon.carbonado.qe">FilteringScore</a> +<div class="block">Evaluates an index for how well it matches a query's desired filtering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html#com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html#com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html#com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html#com.amazon.carbonado.qe">KeyQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/OrderingList.html#com.amazon.carbonado.qe">OrderingList</a> +<div class="block">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/OrderingScore.html#com.amazon.carbonado.qe">OrderingScore</a> +<div class="block">Evaluates an index for how well it matches a query's desired ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryExecutor.html#com.amazon.carbonado.qe">QueryExecutor</a> +<div class="block">Performs all the actual work of executing a query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html#com.amazon.carbonado.qe">QueryExecutorFactory</a> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryFactory.html#com.amazon.carbonado.qe">QueryFactory</a> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryHint.html#com.amazon.carbonado.qe">QueryHint</a> +<div class="block">Defines a hint key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryHints.html#com.amazon.carbonado.qe">QueryHints</a> +<div class="block">An immutable map of query hints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/RepositoryAccess.html#com.amazon.carbonado.qe">RepositoryAccess</a> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html#com.amazon.carbonado.qe">SortedQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StandardQuery.html#com.amazon.carbonado.qe">StandardQuery</a> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StandardQueryFactory.html#com.amazon.carbonado.qe">StandardQueryFactory</a> +<div class="block">Builds and caches StandardQuery instances.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StorableIndexSet.html#com.amazon.carbonado.qe">StorableIndexSet</a> +<div class="block">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StorageAccess.html#com.amazon.carbonado.qe">StorageAccess</a> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html#com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<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> |