summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html')
-rw-r--r--apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html518
1 files changed, 518 insertions, 0 deletions
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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">com.amazon.carbonado.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>&lt;<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>&gt;</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">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>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>&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;?&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;</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>&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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>&nbsp;</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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;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&nbsp;boolean&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;?&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;boolean&nbsp;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&nbsp;boolean&nbsp;canMergeRemainder(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>&nbsp;mergeRemainder(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>&nbsp;mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>&nbsp;withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>&nbsp;withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>&gt;&nbsp;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&nbsp;java.lang.String&nbsp;toString()</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>toString</code>&nbsp;in class&nbsp;<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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>