diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe/StorageAccess.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/qe/StorageAccess.html | 305 |
1 files changed, 305 insertions, 0 deletions
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> |