diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/gen/StorableGenerator.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/gen/StorableGenerator.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/gen/StorableGenerator.html | 755 |
1 files changed, 755 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/gen/StorableGenerator.html b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html new file mode 100644 index 0000000..074f949 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html @@ -0,0 +1,755 @@ +<!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>StorableGenerator (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="StorableGenerator (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/StorableGenerator.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/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableGenerator.html" target="_top">Frames</a></li> +<li><a href="StorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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.gen</div> +<h2 title="Class StorableGenerator" class="title">Class StorableGenerator<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.gen.StorableGenerator<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">StorableGenerator<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">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + types. This greatly simplifies the process of defining new kinds of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repositories</code></a>, since most of the mundane code generation is taken + care of.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider, Tobias Holgers</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>, +<a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#ADAPTER_FIELD_ELEMENT">ADAPTER_FIELD_ELEMENT</a></strong></code> +<div class="block">Adapter field names are propertyName + "$adapter$" + number</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_DELETE_METHOD_NAME">CHECK_PK_FOR_DELETE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_INSERT_METHOD_NAME">CHECK_PK_FOR_INSERT_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_LOAD_METHOD_NAME">CHECK_PK_FOR_LOAD_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_UPDATE_METHOD_NAME">CHECK_PK_FOR_UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CONSTRAINT_FIELD_ELEMENT">CONSTRAINT_FIELD_ELEMENT</a></strong></code> +<div class="block">Constraint field names are propertyName + "$constraint$" + number</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_DELETE_METHOD_NAME">DO_TRY_DELETE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_INSERT_METHOD_NAME">DO_TRY_INSERT_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_LOAD_METHOD_NAME">DO_TRY_LOAD_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_UPDATE_METHOD_NAME">DO_TRY_UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_ALT_KEY_INITIALIZED_PREFIX">IS_ALT_KEY_INITIALIZED_PREFIX</a></strong></code> +<div class="block">Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_PARTITION_KEY_INITIALIZED_METHOD_NAME">IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if any + partition keys are uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_PK_INITIALIZED_METHOD_NAME">IS_PK_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if any + primary keys are uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME">IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_VERSION_INITIALIZED_METHOD_NAME">IS_VERSION_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if + version property is uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#LOAD_COMPLETED_METHOD_NAME">LOAD_COMPLETED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_CLEAN">PROPERTY_STATE_CLEAN</a></strong></code> +<div class="block">Property state indicating that property value reflects a clean value</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_DIRTY">PROPERTY_STATE_DIRTY</a></strong></code> +<div class="block">Property state indicating that property has been set, but not saved</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_FIELD_NAME">PROPERTY_STATE_FIELD_NAME</a></strong></code> +<div class="block">Prefix of protected field in generated storable that holds property + states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_MASK">PROPERTY_STATE_MASK</a></strong></code> +<div class="block">Property state mask is 3, to cover the two bits used by a property state</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_UNINITIALIZED">PROPERTY_STATE_UNINITIALIZED</a></strong></code> +<div class="block">Property state indicating that property has never been set, loaded, or saved</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#SUPPORT_FIELD_NAME">SUPPORT_FIELD_NAME</a></strong></code> +<div class="block">Reference to TriggerSupport instance</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#getAbstractClass(java.lang.Class)">getAbstractClass</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DO_TRY_LOAD_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_LOAD_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_LOAD_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_LOAD_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_INSERT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_INSERT_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_INSERT_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_INSERT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_UPDATE_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_DELETE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_DELETE_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_DELETE_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_DELETE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_INSERT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_INSERT_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_INSERT_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_INSERT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_UPDATE_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_DELETE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_DELETE_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_DELETE_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_DELETE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_LOAD_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_LOAD_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_LOAD_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_LOAD_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PK_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PK_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_PK_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if any + primary keys are uninitialized.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_PK_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PARTITION_KEY_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if any + partition keys are uninitialized.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_PARTITION_KEY_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_ALT_KEY_INITIALIZED_PREFIX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_ALT_KEY_INITIALIZED_PREFIX</h4> +<pre>public static final java.lang.String IS_ALT_KEY_INITIALIZED_PREFIX</pre> +<div class="block">Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized. The complete name is + formed by the prefix appended with the zero-based alternate key number.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_ALT_KEY_INITIALIZED_PREFIX">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_VERSION_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_VERSION_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_VERSION_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if + version property is uninitialized. If no version property exists, then + this method is not defined.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_VERSION_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LOAD_COMPLETED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOAD_COMPLETED_METHOD_NAME</h4> +<pre>public static final java.lang.String LOAD_COMPLETED_METHOD_NAME</pre> +<div class="block">Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.LOAD_COMPLETED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_FIELD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_FIELD_NAME</h4> +<pre>public static final java.lang.String PROPERTY_STATE_FIELD_NAME</pre> +<div class="block">Prefix of protected field in generated storable that holds property + states. Each property consumes two bits to hold its state, and so each + 32-bit field holds states for up to 16 properties.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_FIELD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ADAPTER_FIELD_ELEMENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ADAPTER_FIELD_ELEMENT</h4> +<pre>public static final java.lang.String ADAPTER_FIELD_ELEMENT</pre> +<div class="block">Adapter field names are propertyName + "$adapter$" + number</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.ADAPTER_FIELD_ELEMENT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CONSTRAINT_FIELD_ELEMENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONSTRAINT_FIELD_ELEMENT</h4> +<pre>public static final java.lang.String CONSTRAINT_FIELD_ELEMENT</pre> +<div class="block">Constraint field names are propertyName + "$constraint$" + number</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CONSTRAINT_FIELD_ELEMENT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="SUPPORT_FIELD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SUPPORT_FIELD_NAME</h4> +<pre>public static final java.lang.String SUPPORT_FIELD_NAME</pre> +<div class="block">Reference to TriggerSupport instance</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.SUPPORT_FIELD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_UNINITIALIZED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_UNINITIALIZED</h4> +<pre>public static final int PROPERTY_STATE_UNINITIALIZED</pre> +<div class="block">Property state indicating that property has never been set, loaded, or saved</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_UNINITIALIZED">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_DIRTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_DIRTY</h4> +<pre>public static final int PROPERTY_STATE_DIRTY</pre> +<div class="block">Property state indicating that property has been set, but not saved</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_DIRTY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_CLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_CLEAN</h4> +<pre>public static final int PROPERTY_STATE_CLEAN</pre> +<div class="block">Property state indicating that property value reflects a clean value</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_CLEAN">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_MASK"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PROPERTY_STATE_MASK</h4> +<pre>public static final int PROPERTY_STATE_MASK</pre> +<div class="block">Property state mask is 3, to cover the two bits used by a property state</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_MASK">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAbstractClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAbstractClass</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. The constructor signature for the returned + abstract class is defined as follows: + + <pre> + /** + * @param support Access to triggers + */ + public <init>(TriggerSupport support); + </pre> + + <p>Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + <pre> + // Load the object by examining the primary key. + protected abstract boolean doTryLoad() throws FetchException; + + // Insert the object into the storage layer. + protected abstract boolean doTryInsert() throws PersistException; + + // Update the object in the storage. + protected abstract boolean doTryUpdate() throws PersistException; + + // Delete the object from the storage layer by the primary key. + protected abstract boolean doTryDelete() throws PersistException; + </pre> + + A set of protected hook methods are provided which ensure that all + primary keys are initialized before performing a repository + operation. Subclasses may override them, if they are capable of filling + in unspecified primary keys. One such example is applying a sequence on + insert. + + <pre> + // Throws exception if any primary keys are uninitialized. + // Actual method name defined by CHECK_PK_FOR_INSERT_METHOD_NAME. + protected void checkPkForInsert() throws IllegalStateException; + + // Throws exception if any primary keys are uninitialized. + // Actual method name defined by CHECK_PK_FOR_UPDATE_METHOD_NAME. + protected void checkPkForUpdate() throws IllegalStateException; + + // Throws exception if any primary keys are uninitialized. + // Actual method name defined by CHECK_PK_FOR_DELETE_METHOD_NAME. + protected void checkPkForDelete() throws IllegalStateException; + </pre> + + Each property value is defined as a protected field whose name and type + matches the property. Subclasses should access these fields directly + during loading and storing. For loading, it bypasses constraint + checks. For both, it provides better performance. + + <p>Subclasses also have access to a set of property state bits stored + in protected int fields. Subclasses are not responsible for updating + these values. The intention is that these states may be used by + subclasses to support partial updates. They may otherwise be ignored. + + <p>As a convenience, protected methods are provided to test and alter + the property state bits. Subclass constructors that fill all properties + with loaded values must call loadCompleted to ensure all properties are + identified as being valid and to fire any load triggers. + + <pre> + // Returns true if all primary key properties have been set. + protected boolean isPkInitialized(); + + // Returns true if all partition key properties have been set. + protected boolean isPartitionKeyInitialized(); + + // Returns true if all required data properties are set. + // A required data property is a non-nullable, non-primary key. + protected boolean isRequiredDataInitialized(); + + // Returns true if a version property has been set. + // Note: This method is not generated if there is no version property. + protected boolean isVersionInitialized(); + + // Must be called after load to identify all properties as valid + // and to fire any load triggers. + // Actual method name defined by LOAD_COMPLETED_METHOD_NAME. + protected void loadCompleted() throws FetchException; + </pre> + + Property state field names are defined by the concatenation of + <code>PROPERTY_STATE_FIELD_NAME</code> and a zero-based decimal + number. To determine which field holds a particular property's state, + the field number is computed as the property number divided by 16. The + specific two-bit state position is the remainder of this division times 2.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if Storable type is not well-formed</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableGenerator.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/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableGenerator.html" target="_top">Frames</a></li> +<li><a href="StorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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> |