1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
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>
|
