summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe/StorableIndexSet.html')
-rw-r--r--apidocs/com/amazon/carbonado/qe/StorableIndexSet.html565
1 files changed, 565 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html
new file mode 100644
index 0000000..cfec807
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html
@@ -0,0 +1,565 @@
+<!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>StorableIndexSet (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="StorableIndexSet (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/StorableIndexSet.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/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface 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/StorableIndexSet.html" target="_top">Frames</a></li>
+<li><a href="StorableIndexSet.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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 StorableIndexSet" class="title">Class StorableIndexSet&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.util.AbstractCollection&lt;E&gt;</li>
+<li>
+<ul class="inheritance">
+<li>java.util.AbstractSet&lt;E&gt;</li>
+<li>
+<ul class="inheritance">
+<li>java.util.TreeSet&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;</li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.qe.StorableIndexSet&lt;S&gt;</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.io.Serializable, java.lang.Cloneable, java.lang.Iterable&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;, java.util.Collection&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;, java.util.NavigableSet&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;, java.util.Set&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;, java.util.SortedSet&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">StorableIndexSet&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</span>
+extends java.util.TreeSet&lt;<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;S&gt;&gt;</pre>
+<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>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.amazon.carbonado.qe.StorableIndexSet">Serialized Form</a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet()">StorableIndexSet</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">StorableIndexSet</a></strong>(<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;set)</code>
+<div class="block">Copy constructor.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== 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>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">addAlternateKeys</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</code>
+<div class="block">Adds all of the alternate keys of the given storable as indexes by
+ calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo)">addIndexes</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</code>
+<div class="block">Adds all the indexes of the given storable.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info,
+ <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;defaultDirection)</code>
+<div class="block">Adds all the indexes of the given storable.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><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="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">addPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</code>
+<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</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"><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><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"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</code>
+<div class="block">Finds the best index to represent the primary key.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#markClustered(boolean)">markClustered</a></strong>(boolean&nbsp;clustered)</code>
+<div class="block">Marks all indexes as clustered or non-clustered.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce()">reduce</a></strong>()</code>
+<div class="block">Reduces the size of the set by removing redundant indexes, and merges
+ others together.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce(com.amazon.carbonado.info.Direction)">reduce</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;defaultDirection)</code>
+<div class="block">Reduces the size of the set by removing redundant indexes, and merges
+ others together.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;defaultDirection)</code>
+<div class="block">Set the default direction for all index properties.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</code>
+<div class="block">Augment non-unique indexes with primary key properties, thus making them
+ unique.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><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>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.util.TreeSet">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.util.TreeSet</h3>
+<code>add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, subSet, subSet, tailSet, tailSet</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractSet">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.util.AbstractSet</h3>
+<code>equals, hashCode, removeAll</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.util.AbstractCollection</h3>
+<code>containsAll, retainAll, toArray, toArray, toString</code></li>
+</ul>
+<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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.util.Set">
+<!-- -->
+</a>
+<h3>Methods inherited from interface&nbsp;java.util.Set</h3>
+<code>containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="StorableIndexSet()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>StorableIndexSet</h4>
+<pre>public&nbsp;StorableIndexSet()</pre>
+</li>
+</ul>
+<a name="StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>StorableIndexSet</h4>
+<pre>public&nbsp;StorableIndexSet(<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;set)</pre>
+<div class="block">Copy constructor.</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="addIndexes(com.amazon.carbonado.info.StorableInfo)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addIndexes</h4>
+<pre>public&nbsp;void&nbsp;addIndexes(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</pre>
+<div class="block">Adds all the indexes of the given storable.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl>
+</li>
+</ul>
+<a name="addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addIndexes</h4>
+<pre>public&nbsp;void&nbsp;addIndexes(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info,
+ <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;defaultDirection)</pre>
+<div class="block">Adds all the indexes of the given storable.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - default ordering direction to apply to each
+ index property</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null</dd></dl>
+</li>
+</ul>
+<a name="addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addAlternateKeys</h4>
+<pre>public&nbsp;void&nbsp;addAlternateKeys(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</pre>
+<div class="block">Adds all of the alternate keys of the given storable as indexes by
+ calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl>
+</li>
+</ul>
+<a name="addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addPrimaryKey</h4>
+<pre>public&nbsp;void&nbsp;addPrimaryKey(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</pre>
+<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>. This method should not be called if the primary key
+ cannot be altered because persistent data is already stored against
+ it. Instead, the primary key index should be added as a normal index.
+
+ <p>After adding the primary key via this method and after reducing the
+ set, call <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)"><code>findPrimaryKeyIndex</code></a> to get the
+ best index to represent the primary key.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl>
+</li>
+</ul>
+<a name="addKey(com.amazon.carbonado.info.StorableKey)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addKey</h4>
+<pre>public&nbsp;void&nbsp;addKey(<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)</pre>
+<div class="block">Adds the key as a unique index, preserving the property arrangement.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if key is null</dd></dl>
+</li>
+</ul>
+<a name="reduce()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reduce</h4>
+<pre>public&nbsp;void&nbsp;reduce()</pre>
+<div class="block">Reduces the size of the set by removing redundant indexes, and merges
+ others together.</div>
+</li>
+</ul>
+<a name="reduce(com.amazon.carbonado.info.Direction)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reduce</h4>
+<pre>public&nbsp;void&nbsp;reduce(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;defaultDirection)</pre>
+<div class="block">Reduces the size of the set by removing redundant indexes, and merges
+ others together.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - replace unspecified property directions with this</dd></dl>
+</li>
+</ul>
+<a name="setDefaultDirection(com.amazon.carbonado.info.Direction)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDefaultDirection</h4>
+<pre>public&nbsp;void&nbsp;setDefaultDirection(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;defaultDirection)</pre>
+<div class="block">Set the default direction for all index properties.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - replace unspecified property directions with this</dd></dl>
+</li>
+</ul>
+<a name="markClustered(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>markClustered</h4>
+<pre>public&nbsp;void&nbsp;markClustered(boolean&nbsp;clustered)</pre>
+<div class="block">Marks all indexes as clustered or non-clustered.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clustered</code> - true to mark clustered; false to mark non-clustered</dd><dt><span class="strong">Since:</span></dt>
+ <dd>1.2</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isClustered()"><code>StorableIndex.isClustered()</code></a></dd></dl>
+</li>
+</ul>
+<a name="uniquify(com.amazon.carbonado.info.StorableInfo)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>uniquify</h4>
+<pre>public&nbsp;void&nbsp;uniquify(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</pre>
+<div class="block">Augment non-unique indexes with primary key properties, thus making them
+ unique.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl>
+</li>
+</ul>
+<a name="uniquify(com.amazon.carbonado.info.StorableKey)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>uniquify</h4>
+<pre>public&nbsp;void&nbsp;uniquify(<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)</pre>
+<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if key is null</dd></dl>
+</li>
+</ul>
+<a name="findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>findPrimaryKeyIndex</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/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;findPrimaryKeyIndex(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a>&lt;<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;info)</pre>
+<div class="block">Finds the best index to represent the primary key. Should be called
+ after calling reduce. As long as the primary key was added via <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)"><code>addPrimaryKey</code></a>, this method should never return null.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl>
+</li>
+</ul>
+<a name="findKeyIndex(com.amazon.carbonado.info.StorableKey)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>findKeyIndex</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/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>&gt;&nbsp;findKeyIndex(<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)</pre>
+<div class="block">Finds the best index to represent the given key. Should be called after
+ calling reduce. As long as the key was added via <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>,
+ this method should never return null.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if key is null</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/StorableIndexSet.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/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface 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/StorableIndexSet.html" target="_top">Frames</a></li>
+<li><a href="StorableIndexSet.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>