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/index-files/index-17.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files/index-17.html')
| -rw-r--r-- | apidocs/index-files/index-17.html | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/apidocs/index-files/index-17.html b/apidocs/index-files/index-17.html new file mode 100644 index 0000000..51b5a60 --- /dev/null +++ b/apidocs/index-files/index-17.html @@ -0,0 +1,230 @@ +<!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>Q-Index (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="Q-Index (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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-16.html">Prev Letter</a></li> +<li><a href="index-18.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-17.html" target="_top">Frames</a></li> +<li><a href="index-17.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_Q_"> +<!-- --> +</a> +<h2 class="title">Q</h2> +<dl> +<dt><span class="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(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></dt> +<dd> +<div class="block">Returns a query that handles the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query that fetches everything.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query(String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query(Filter<S>, OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><span class="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(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><span class="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(Filter<S>, FilterValues<S>, OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><span class="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(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Query</span></a><<a href="../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Supports complex retrieval and deletion of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#query()">query()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Query for all Storable instances in this Storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)">query(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Query for Storable instances against a filter expression.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#query(com.amazon.carbonado.filter.Filter)">query(Filter<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Query.Controller</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Controller instance can be used to abort query operations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Query.Timeout</span></a> - Class in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Timeout controller, for aborting long running queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#Query.Timeout(long, java.util.concurrent.TimeUnit)">Query.Timeout(long, TimeUnit)</a></span> - Constructor for class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#QUERY_METHOD_NAME">QUERY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storage API method name</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryEngine</span></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>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Complete rule-based query engine implementation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryEngine.html#QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">QueryEngine(Class<S>, RepositoryAccess)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Performs all the actual work of executing a query.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryExecutorCache</span></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>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html#QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)">QueryExecutorCache(QueryExecutorFactory<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutorFactory</span></a><<a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<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> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryFactory</span></a><<a href="../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#queryFactory()">queryFactory()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">QueryHint</span></a> - Enum in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Defines a hint key.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryHints</span></a> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">An immutable map of query hints.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">QuickConstructorGenerator</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use <code>QuickConstructorGenerator</code></i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html#QuickConstructorGenerator()">QuickConstructorGenerator()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">QuickConstructorGenerator</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-16.html">Prev Letter</a></li> +<li><a href="index-18.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-17.html" target="_top">Frames</a></li> +<li><a href="index-17.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> |