diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html | 346 |
1 files changed, 346 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..9b834f5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SyntheticStorableReferenceAccess (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="SyntheticStorableReferenceAccess (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/SyntheticStorableReferenceAccess.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/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceAccess.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.synthetic</div> +<h2 title="Class SyntheticStorableReferenceAccess" class="title">Class SyntheticStorableReferenceAccess<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SyntheticStorableReferenceAccess<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Provides access to the generated storable reference class and utility + methods.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd> +<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/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>SyntheticStorableReferenceBuilder</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/synthetic/SyntheticStorableReferenceAccess.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> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the properties of the given reference, 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/synthetic/SyntheticStorableReferenceAccess.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> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given reference.</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/synthetic/SyntheticStorableReferenceAccess.html#getComparator()">getComparator</a></strong>()</code> +<div class="block">Returns a comparator for ordering storable reference instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getMasterClass()">getMasterClass</a></strong>()</code> +<div class="block">Returns the storable class which is referenced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? 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/synthetic/SyntheticStorableReferenceAccess.html#getReferenceClass()">getReferenceClass</a></strong>()</code> +<div class="block">Returns the generated storable reference class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.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> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property.</div> +</td> +</tr> +</table> +<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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMasterClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMasterClass</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a>> getMasterClass()</pre> +<div class="block">Returns the storable class which is referenced.</div> +</li> +</ul> +<a name="getReferenceClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReferenceClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getReferenceClass()</pre> +<div class="block">Returns the generated storable reference class.</div> +</li> +</ul> +<a name="getComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComparator</h4> +<pre>public 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 storable reference instances. This + order matches the primary key of the master storable.</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>public void copyToMasterPrimaryKey(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">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 reference.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</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>public void copyFromMaster(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">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 reference, using the applicable + properties of the given master.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - reference 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="blockListLast"> +<li class="blockList"> +<h4>isConsistent</h4> +<pre>public boolean isConsistent(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">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 reference match those + contained in the master, excluding any version property. This will + always return true after a call to copyFromMaster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - reference 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> +</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/SyntheticStorableReferenceAccess.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/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceAccess.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> |