diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/indexed')
14 files changed, 2998 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html new file mode 100644 index 0000000..53038eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html @@ -0,0 +1,226 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexEntryAccessCapability (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="IndexEntryAccessCapability (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/IndexEntryAccessCapability.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/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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.repo.indexed</div> +<h2 title="Interface IndexEntryAccessCapability" class="title">Interface IndexEntryAccessCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexEntryAccessCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</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><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</td> +</tr> +</table> +</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="getIndexEntryAccessors(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getIndexEntryAccessors</h4> +<pre><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[] getIndexEntryAccessors(java.lang.Class<S> storableType) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type. The array might be empty, but it is never null. The array + is a copy, and so it may be safely modified.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/IndexEntryAccessCapability.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/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html new file mode 100644 index 0000000..7a61df5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html @@ -0,0 +1,346 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexEntryAccessor (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="IndexEntryAccessor (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/IndexEntryAccessor.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/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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.repo.indexed</div> +<h2 title="Interface IndexEntryAccessor" class="title">Interface IndexEntryAccessor<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/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexEntryAccessor<S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></pre> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</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="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><code>IndexEntryAccessCapability</code></a></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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getComparator()">getComparator</a></strong>()</code> +<div class="block">Returns a comparator for ordering index entries.</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><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getIndexEntryStorage()">getIndexEntryStorage</a></strong>()</code> +<div class="block">Returns the index entry storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#repair(double)">repair</a></strong>(double desiredSpeed)</code> +<div class="block">Repairs the index by inserting missing entries and fixing + inconsistencies.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.capability.IndexInfo"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></h3> +<code><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique</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="getIndexEntryStorage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexEntryStorage</h4> +<pre><a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><?> getIndexEntryStorage()</pre> +<div class="block">Returns the index entry storage.</div> +</li> +</ul> +<a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyToMasterPrimaryKey</h4> +<pre>void copyToMasterPrimaryKey(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - source of property values</dd><dd><code>master</code> - master whose primary key properties will be set</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="copyFromMaster(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyFromMaster(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyFromMaster</h4> +<pre>void copyFromMaster(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - index entry whose properties will be set</dd><dd><code>master</code> - source of property values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="isConsistent(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="isConsistent(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isConsistent</h4> +<pre>boolean isConsistent(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property. This will always + return true after a call to copyFromMaster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - index entry whose properties will be tested</dd><dd><code>master</code> - source of property values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="repair(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>repair</h4> +<pre>void repair(double desiredSpeed) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Repairs the index by inserting missing entries and fixing + inconsistencies.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getComparator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getComparator</h4> +<pre>java.util.Comparator<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getComparator()</pre> +<div class="block">Returns a comparator for ordering index entries.</div> +</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/IndexEntryAccessor.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/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..a18c2a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html @@ -0,0 +1,616 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexedRepositoryBuilder (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="IndexedRepositoryBuilder (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/IndexedRepositoryBuilder.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>Prev Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.repo.indexed</div> +<h2 title="Class IndexedRepositoryBuilder" class="title">Class IndexedRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexedRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Repository builder for the indexed repository. + <p> + In addition to supporting the capabilities of the wrapped repository, the + following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><code>IndexEntryAccessCapability</code></a> + </ul></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"> +<!-- ======== 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"> </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/repo/indexed/IndexedRepositoryBuilder.html#IndexedRepositoryBuilder()">IndexedRepositoryBuilder</a></strong>()</code> </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"> </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><a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle</a></strong>()</code> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getWrappedRepository()">getWrappedRepository</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isAllClustered()">isAllClustered</a></strong>()</code> +<div class="block">Returns true if all indexes should be identified as clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setAllClustered(boolean)">setAllClustered</a></strong>(boolean clustered)</code> +<div class="block">When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairDiscardDuplicates(boolean)">setIndexRepairDiscardDuplicates</a></strong>(boolean discardDuplicates)</code> +<div class="block">Set true to skip collisions during index repair, logging each as a + warning.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled</a></strong>(boolean enabled)</code> +<div class="block">By default, index repair is enabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle</a></strong>(double desiredSpeed)</code> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairVerifyOnly(boolean)">setIndexRepairVerifyOnly</a></strong>(boolean verifyOnly)</code> +<div class="block">Set true to build and verify indexes, but don't apply any changes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setStrictTriggers(boolean)">setStrictTriggers</a></strong>(boolean strict)</code> +<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)">setWrappedRepository</a></strong>(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</code> +<div class="block">Set the required wrapped respository, which must support the + <a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="IndexedRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexedRepositoryBuilder</h4> +<pre>public IndexedRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="getWrappedRepository()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWrappedRepository</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> getWrappedRepository()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>wrapped respository</dd></dl> +</li> +</ul> +<a name="setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWrappedRepository</h4> +<pre>public void setWrappedRepository(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</pre> +<div class="block">Set the required wrapped respository, which must support the + <a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div> +</li> +</ul> +<a name="isIndexRepairEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexRepairEnabled</h4> +<pre>public boolean isIndexRepairEnabled()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true by default</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)"><code>setIndexRepairEnabled(boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setIndexRepairEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairEnabled</h4> +<pre>public void setIndexRepairEnabled(boolean enabled)</pre> +<div class="block">By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + + <p>When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the <i>intersection</i> of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the <i>union</i> of the old and new index sets. + + <p>While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.</div> +</li> +</ul> +<a name="getIndexRepairThrottle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexRepairThrottle</h4> +<pre>public double getIndexRepairThrottle()</pre> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.</div> +</li> +</ul> +<a name="setIndexRepairThrottle(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairThrottle</h4> +<pre>public void setIndexRepairThrottle(double desiredSpeed)</pre> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work</dd></dl> +</li> +</ul> +<a name="setIndexRepairDiscardDuplicates(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairDiscardDuplicates</h4> +<pre>public void setIndexRepairDiscardDuplicates(boolean discardDuplicates)</pre> +<div class="block">Set true to skip collisions during index repair, logging each as a + warning.</div> +</li> +</ul> +<a name="setIndexRepairVerifyOnly(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairVerifyOnly</h4> +<pre>public void setIndexRepairVerifyOnly(boolean verifyOnly)</pre> +<div class="block">Set true to build and verify indexes, but don't apply any changes.</div> +</li> +</ul> +<a name="isAllClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAllClustered</h4> +<pre>public boolean isAllClustered()</pre> +<div class="block">Returns true if all indexes should be identified as clustered. This + affects how indexes are selected by the query analyzer.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setAllClustered(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllClustered</h4> +<pre>public void setAllClustered(boolean clustered)</pre> +<div class="block">When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well. This is suitable for indexing + repositories that never read from a slow storage medium.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setStrictTriggers(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStrictTriggers</h4> +<pre>public void setStrictTriggers(boolean strict)</pre> +<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.</div> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/IndexedRepositoryBuilder.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>Prev Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html new file mode 100644 index 0000000..9ce8482 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html @@ -0,0 +1,375 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StoredIndexInfo (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="StoredIndexInfo (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/StoredIndexInfo.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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" target="_top">Frames</a></li> +<li><a href="StoredIndexInfo.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.repo.indexed</div> +<h2 title="Interface StoredIndexInfo" class="title">Interface StoredIndexInfo</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/Storable.html" title="interface in com.amazon.carbonado">Storable</a>, <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, <a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>="indexName") +<a href="../../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_INDEX_INFO") +public interface <span class="strong">StoredIndexInfo</span> +extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>, <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, <a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></pre> +<div class="block">Stores basic information about the indexes managed by IndexedRepository. + + <p>Note: This storable cannot have indexes defined, since it is used to + discover information about indexes. It would create a cyclic dependency.</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getCreationTimestamp()">getCreationTimestamp</a></strong>()</code> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getExtraData()">getExtraData</a></strong>()</code> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexName()">getIndexName</a></strong>()</code> +<div class="block">Returns the index name, which is also a valid index name + descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor</a></strong>()</code> +<div class="block">Returns the types of the index properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredIndexInfo instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setCreationTimestamp(long)">setCreationTimestamp</a></strong>(long timestamp)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setIndexName(java.lang.String)">setIndexName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setIndexTypeDescriptor(java.lang.String)">setIndexTypeDescriptor</a></strong>(java.lang.String descriptor)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setVersionNumber(int)">setVersionNumber</a></strong>(int version)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</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="getIndexName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexName</h4> +<pre>java.lang.String getIndexName()</pre> +<div class="block">Returns the index name, which is also a valid index name + descriptor. This descriptor is defined by <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a>. The name descriptor does not + contain type information.</div> +</li> +</ul> +<a name="setIndexName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexName</h4> +<pre>void setIndexName(java.lang.String name)</pre> +</li> +</ul> +<a name="getIndexTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexTypeDescriptor</h4> +<pre><a href="../../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getIndexTypeDescriptor()</pre> +<div class="block">Returns the types of the index properties. This descriptor is defined by + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a>.</div> +</li> +</ul> +<a name="setIndexTypeDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexTypeDescriptor</h4> +<pre>void setIndexTypeDescriptor(java.lang.String descriptor)</pre> +</li> +</ul> +<a name="getCreationTimestamp()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationTimestamp</h4> +<pre>long getCreationTimestamp()</pre> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</li> +</ul> +<a name="setCreationTimestamp(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationTimestamp</h4> +<pre>void setCreationTimestamp(long timestamp)</pre> +</li> +</ul> +<a name="getVersionNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionNumber</h4> +<pre><a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +int getVersionNumber()</pre> +<div class="block">Record version number for this StoredIndexInfo instance. Some encoding + strategies require a version number.</div> +</li> +</ul> +<a name="setVersionNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersionNumber</h4> +<pre>void setVersionNumber(int version)</pre> +</li> +</ul> +<a name="getExtraData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraData</h4> +<pre><a href="../../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +byte[] getExtraData()</pre> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.</div> +</li> +</ul> +<a name="setExtraData(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setExtraData</h4> +<pre>void setExtraData(byte[] data)</pre> +</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/StoredIndexInfo.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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" target="_top">Frames</a></li> +<li><a href="StoredIndexInfo.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html new file mode 100644 index 0000000..1563e98 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html @@ -0,0 +1,171 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Unindexed (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="Unindexed (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/Unindexed.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/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.repo.indexed</div> +<h2 title="Interface Unindexed" class="title">Interface Unindexed</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Unindexed</span></pre> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Unindexed.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/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html new file mode 100644 index 0000000..38e77db --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html @@ -0,0 +1,117 @@ +<!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.repo.indexed.IndexEntryAccessCapability (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.repo.indexed.IndexEntryAccessCapability (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/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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.repo.indexed.IndexEntryAccessCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability</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/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html new file mode 100644 index 0000000..0349ef9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html @@ -0,0 +1,163 @@ +<!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.repo.indexed.IndexEntryAccessor (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.repo.indexed.IndexEntryAccessor (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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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.repo.indexed.IndexEntryAccessor" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.IndexEntryAccessor</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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></span><span class="tabEnd"> </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.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a> in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</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/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that return <a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[]</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..5ae0a01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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 Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder (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 Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder (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/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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 Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</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/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html new file mode 100644 index 0000000..c9b990f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html @@ -0,0 +1,117 @@ +<!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.repo.indexed.StoredIndexInfo (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.repo.indexed.StoredIndexInfo (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/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/StoredIndexInfo.html" target="_top">Frames</a></li> +<li><a href="StoredIndexInfo.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.repo.indexed.StoredIndexInfo" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.StoredIndexInfo</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.indexed.StoredIndexInfo</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/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/StoredIndexInfo.html" target="_top">Frames</a></li> +<li><a href="StoredIndexInfo.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html new file mode 100644 index 0000000..cb241b5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html @@ -0,0 +1,189 @@ +<!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.repo.indexed.Unindexed (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.repo.indexed.Unindexed (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/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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.repo.indexed.Unindexed" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.Unindexed</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/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></span><span class="tabEnd"> </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.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a> in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a> in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that implement <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</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/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">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/repo/indexed/class-use/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html b/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html new file mode 100644 index 0000000..4bed9bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html @@ -0,0 +1,27 @@ +<!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>com.amazon.carbonado.repo.indexed (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html" target="classFrame">com.amazon.carbonado.repo.indexed</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>IndexEntryAccessCapability</i></a></li> +<li><a href="IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>IndexEntryAccessor</i></a></li> +<li><a href="StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>StoredIndexInfo</i></a></li> +<li><a href="Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>Unindexed</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed" target="classFrame">IndexedRepositoryBuilder</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html new file mode 100644 index 0000000..07a36e4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html @@ -0,0 +1,187 @@ +<!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>com.amazon.carbonado.repo.indexed (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="com.amazon.carbonado.repo.indexed (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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/raw/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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="Package" class="title">Package com.amazon.carbonado.repo.indexed</h1> +<div class="docSummary"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a></td> +<td class="colLast"> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></td> +<td class="colLast"> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></td> +<td class="colLast"> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Repository builder for the indexed repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.indexed Description">Package com.amazon.carbonado.repo.indexed Description</h2> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support. The wrapped repository must support creation of + new types.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><code>IndexedRepositoryBuilder</code></a></dd></dl> +</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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/raw/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html b/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html new file mode 100644 index 0000000..0e00182 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html @@ -0,0 +1,162 @@ +<!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>com.amazon.carbonado.repo.indexed Class Hierarchy (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="com.amazon.carbonado.repo.indexed Class Hierarchy (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>Use</li> +<li class="navBarCell1Rev">Tree</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/raw/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.indexed</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">IndexedRepositoryBuilder</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfo</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessor</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Unevolvable</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> (also extends com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>, com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Unindexed</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> (also extends com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>, com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</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>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/raw/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-use.html b/apidocs/com/amazon/carbonado/repo/indexed/package-use.html new file mode 100644 index 0000000..c6e3662 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-use.html @@ -0,0 +1,185 @@ +<!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.repo.indexed (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.repo.indexed (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/repo/indexed/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.repo.indexed" class="title">Uses of Package<br>com.amazon.carbonado.repo.indexed</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/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </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.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</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/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> used by <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </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/repo/indexed/class-use/IndexEntryAccessor.html#com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/indexed/class-use/Unindexed.html#com.amazon.carbonado.repo.indexed">Unindexed</a> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</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/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> used by <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </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/repo/indexed/class-use/Unindexed.html#com.amazon.carbonado.repo.sleepycat">Unindexed</a> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</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/repo/indexed/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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |