summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/info/class-use/StorableKey.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/info/class-use/StorableKey.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/info/class-use/StorableKey.html')
-rw-r--r--apidocs/com/amazon/carbonado/info/class-use/StorableKey.html247
1 files changed, 247 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html
new file mode 100644
index 0000000..377457c
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html
@@ -0,0 +1,247 @@
+<!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.info.StorableKey (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.info.StorableKey (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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableKey.html" target="_top">Frames</a></li>
+<li><a href="StorableKey.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.info.StorableKey" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableKey</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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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.info">com.amazon.carbonado.info</a></td>
+<td class="colLast">
+<div class="block">Introspection support for Storables.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<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.info">
+<!-- -->
+</a>
+<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</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/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></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>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a>&lt;<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>&gt;</code></td>
+<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey</a></strong>(int&nbsp;index)</code>
+<div class="block">Returns a specific alternate key for the Storable.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a>&lt;<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>&gt;[]</code></td>
+<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys</a></strong>()</code>
+<div class="block">Returns a new array with all the alternate keys in it.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a>&lt;<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>&gt;</code></td>
+<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey</a></strong>()</code>
+<div class="block">Returns the partition key for the Storable, or null if none exists.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a>&lt;<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>&gt;</code></td>
+<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey</a></strong>()</code>
+<div class="block">Returns the primary key for the Storable, never null.</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/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></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>
+<tbody>
+<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>&gt;</code></td>
+<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.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>&lt;<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>&gt;&nbsp;key)</code>
+<div class="block">Returns a StorableIndex which is unique, possibly by appending
+ properties from the given key.</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/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></span><span class="tabEnd">&nbsp;</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/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a>&lt;<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>&gt;&nbsp;key,
+ <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;direction)</code>
+<div class="block">Creates a StorableIndex from a StorableKey.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList"><a name="com.amazon.carbonado.qe">
+<!-- -->
+</a>
+<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></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>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><span class="strong">StorableIndexSet.</span><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>&lt;<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;key)</code>
+<div class="block">Adds the key as a unique index, preserving the property arrangement.</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>&lt;<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;</code></td>
+<td class="colLast"><span class="strong">StorableIndexSet.</span><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>&lt;<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;key)</code>
+<div class="block">Finds the best index to represent the given key.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><span class="strong">StorableIndexSet.</span><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>&lt;<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;key)</code>
+<div class="block">Augment non-unique indexes with key properties, thus making them unique.</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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableKey.html" target="_top">Frames</a></li>
+<li><a href="StorableKey.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>