summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html')
-rw-r--r--apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html346
1 files changed, 346 insertions, 0 deletions
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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">com.amazon.carbonado.repo.indexed</div>
+<h2 title="Interface IndexEntryAccessor" class="title">Interface IndexEntryAccessor&lt;S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</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&lt;S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</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">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/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>&nbsp;indexEntry,
+ <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a>&nbsp;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>&nbsp;indexEntry,
+ <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a>&nbsp;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&lt;? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</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>&lt;?&gt;</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>&nbsp;indexEntry,
+ <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a>&nbsp;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&nbsp;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&nbsp;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>&lt;?&gt;&nbsp;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&nbsp;copyToMasterPrimaryKey(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&nbsp;indexEntry,
+ <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a>&nbsp;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&nbsp;copyFromMaster(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&nbsp;indexEntry,
+ <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a>&nbsp;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&nbsp;isConsistent(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&nbsp;indexEntry,
+ <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a>&nbsp;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&nbsp;repair(double&nbsp;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&lt;? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>