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
|
<!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_60) on Tue Feb 17 12:25:55 EST 2015 -->
<title>AnnotationModel (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2015-02-17">
<link rel="stylesheet" type="text/css" href="../../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AnnotationModel (Oracle - Berkeley DB Java 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/AnnotationModel.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../com/sleepycat/persist/model/ClassEnhancer.html" title="class in com.sleepycat.persist.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/persist/model/AnnotationModel.html" target="_top">Frames</a></li>
<li><a href="AnnotationModel.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.sleepycat.persist.model</div>
<h2 title="Class AnnotationModel" class="title">Class AnnotationModel</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">com.sleepycat.persist.model.EntityModel</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.persist.model.AnnotationModel</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">AnnotationModel</span>
extends <a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></pre>
<div class="block">The default annotation-based entity model. An <code>AnnotationModel</code>
is based on annotations that are specified for entity classes and their key
fields.
<p><code>AnnotationModel</code> objects are thread-safe. Multiple threads may
safely call the methods of a shared <code>AnnotationModel</code> object.</p>
<p>The set of persistent classes in the annotation model is the set of all
classes with the <a href="../../../../com/sleepycat/persist/model/Persistent.html" title="annotation in com.sleepycat.persist.model"><code>Persistent</code></a> or <a href="../../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><code>Entity</code></a> annotation.</p>
<p>The annotations used to define persistent classes are: <a href="../../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><code>Entity</code></a>,
<a href="../../../../com/sleepycat/persist/model/Persistent.html" title="annotation in com.sleepycat.persist.model"><code>Persistent</code></a>, <a href="../../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><code>PrimaryKey</code></a>, <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> and <a href="../../../../com/sleepycat/persist/model/KeyField.html" title="annotation in com.sleepycat.persist.model"><code>KeyField</code></a>. A good starting point is <a href="../../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><code>Entity</code></a>.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/sleepycat/persist/model/AnnotationModel.html#AnnotationModel()">AnnotationModel</a></strong>()</code>
<div class="block">Constructs a model for annotated entity classes.</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><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/AnnotationModel.html#getClassMetadata(java.lang.String)">getClassMetadata</a></strong>(java.lang.String className)</code>
<div class="block">Returns the metadata for a given persistent class name, including proxy
classes and entity classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/AnnotationModel.html#getEntityMetadata(java.lang.String)">getEntityMetadata</a></strong>(java.lang.String className)</code>
<div class="block">Returns the metadata for a given entity class name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/AnnotationModel.html#getKnownClasses()">getKnownClasses</a></strong>()</code>
<div class="block">Returns the names of all known persistent classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/AnnotationModel.html#getKnownSpecialClasses()">getKnownSpecialClasses</a></strong>()</code>
<div class="block">Returns the names of all known persistent enum and array classes that
may be used to store persistent data.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.persist.model.EntityModel">
<!-- -->
</a>
<h3>Methods inherited from class com.sleepycat.persist.model.<a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></h3>
<code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#classForName(java.lang.String)">classForName</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#convertRawObject(com.sleepycat.persist.raw.RawObject)">convertRawObject</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypes()">getAllRawTypes</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypeVersions(java.lang.String)">getAllRawTypeVersions</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getRawType(java.lang.String)">getRawType</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getRawTypeVersion(java.lang.String,%20int)">getRawTypeVersion</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#isOpen()">isOpen</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#registerClass(java.lang.Class)">registerClass</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#resolveClass(java.lang.String)">resolveClass</a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#setCatalog(com.sleepycat.persist.impl.PersistCatalog)">setCatalog</a></code></li>
</ul>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AnnotationModel()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AnnotationModel</h4>
<pre>public AnnotationModel()</pre>
<div class="block">Constructs a model for annotated entity classes.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getKnownClasses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKnownClasses</h4>
<pre>public java.util.Set<java.lang.String> getKnownClasses()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()">EntityModel</a></code></strong></div>
<div class="block">Returns the names of all known persistent classes. A type becomes known
when an instance of the type is stored for the first time or metadata or
type information is queried for a specific class name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()">getKnownClasses</a></code> in class <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an unmodifiable set of class names.</dd></dl>
</li>
</ul>
<a name="getKnownSpecialClasses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKnownSpecialClasses</h4>
<pre>public java.util.Set<java.lang.String> getKnownSpecialClasses()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownSpecialClasses()">EntityModel</a></code></strong></div>
<div class="block">Returns the names of all known persistent enum and array classes that
may be used to store persistent data. This differs from
<a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()"><code>EntityModel.getKnownClasses()</code></a>, which does not return enum and array classes
because they have no metadata.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownSpecialClasses()">getKnownSpecialClasses</a></code> in class <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an unmodifiable set of enum and array class names.</dd></dl>
</li>
</ul>
<a name="getEntityMetadata(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityMetadata</h4>
<pre>public <a href="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</a> getEntityMetadata(java.lang.String className)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getEntityMetadata(java.lang.String)">EntityModel</a></code></strong></div>
<div class="block">Returns the metadata for a given entity class name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getEntityMetadata(java.lang.String)">getEntityMetadata</a></code> in class <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the metadata or null if the class is not an entity class or does
not exist.</dd></dl>
</li>
</ul>
<a name="getClassMetadata(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getClassMetadata</h4>
<pre>public <a href="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</a> getClassMetadata(java.lang.String className)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getClassMetadata(java.lang.String)">EntityModel</a></code></strong></div>
<div class="block">Returns the metadata for a given persistent class name, including proxy
classes and entity classes.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getClassMetadata(java.lang.String)">getClassMetadata</a></code> in class <code><a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the metadata or null if the class is not persistent or does not
exist.</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/AnnotationModel.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../com/sleepycat/persist/model/ClassEnhancer.html" title="class in com.sleepycat.persist.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/persist/model/AnnotationModel.html" target="_top">Frames</a></li>
<li><a href="AnnotationModel.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
|
