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
|
<!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>
|
