Adding javadocs and Carbonado User Guidegh-pages

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/package-use.html
1 files changed, 265 insertions, 0 deletions
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">&nbsp;</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">&nbsp;</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>&nbsp;</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>&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>
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/package-use.html