-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathFenixFramework.html
544 lines (471 loc) · 28.2 KB
/
FenixFramework.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_37) on Mon Jan 21 17:29:56 WET 2013 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
FenixFramework (Fenix Framework Distribution 2.0 API)
</TITLE>
<META NAME="date" CONTENT="2013-01-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FenixFramework (Fenix Framework Distribution 2.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FenixFramework.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../pt/ist/fenixframework/DomainRoot_Base.html" title="class in pt.ist.fenixframework"><B>PREV CLASS</B></A>
<A HREF="../../../pt/ist/fenixframework/MultiConfig.html" title="class in pt.ist.fenixframework"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?pt/ist/fenixframework/FenixFramework.html" target="_top"><B>FRAMES</B></A>
<A HREF="FenixFramework.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
pt.ist.fenixframework</FONT>
<BR>
Class FenixFramework</H2>
<map id="G" name="G">
<area shape="rect" id="c10692" href="./FenixFramework.html" title="pt.ist.fenixframework.FenixFramework" alt="" coords="15,17,137,42"/>
</map>
<!-- UML diagram added by UMLGraph version 5.1 (http://www.umlgraph.org/) -->
<div align="center"><img src="FenixFramework.png" alt="Package class diagram package FenixFramework" usemap="#G" border=0/></div>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>pt.ist.fenixframework.FenixFramework</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>FenixFramework</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
<p>This is the main class for the Fenix Framework. It is the central point for obtaining most of
the APIs that the user of the framework (a programmer) should need.
<p>Before being able to use the framework, a program must initialize it, by providing a
configuration. There are two (disjoint) alternative methods to initialize the FenixFramework:
<ul>
<li><strong>By convention</strong>: When the FenixFramework class is loaded, its static
initialization code will check for the presence of a properties file that provides the
configuration information.</li>
<li><strong>Explicitly</strong>: The programmer either creates a <A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework"><CODE>Config</CODE></A> or <A HREF="../../../pt/ist/fenixframework/MultiConfig.html" title="class in pt.ist.fenixframework"><CODE>MultiConfig</CODE></A> instance and then explicitly calls the corresponding initialization method: <A HREF="../../../pt/ist/fenixframework/FenixFramework.html#initialize(pt.ist.fenixframework.Config)"><CODE>initialize(Config)</CODE></A> or <A HREF="../../../pt/ist/fenixframework/FenixFramework.html#initialize(pt.ist.fenixframework.MultiConfig)"><CODE>initialize(MultiConfig)</CODE></A>.</li>
</ul>
<p>Using the configuration by convention, the framework will first look up the name of the <A HREF="../../../pt/ist/fenixframework/backend/BackEnd.html" title="interface in pt.ist.fenixframework.backend"><CODE>BackEnd</CODE></A> that generated the domain-specific code (this is done by
instantiating the class <A HREF="../../../pt/ist/fenixframework/backend/CurrentBackEndId.html" title="class in pt.ist.fenixframework.backend"><CODE>CurrentBackEndId</CODE></A> and by requesting
<A HREF="../../../pt/ist/fenixframework/backend/BackEndId.html#getBackEndName()"><CODE>BackEndId.getBackEndName()</CODE></A>) and then use that name to check
for the presence of the file '<code>fenix-framework-<NNN>.properties</code>' in the
classpath using <code>Thread.currentThread().getContextClassLoader().getResource()</code> (where
<code><NNN></code> is the name of the BackEnd). If this file is found, and contains the
correct content, the framework will create the appropriate Config instance and automatically
invoke <A HREF="../../../pt/ist/fenixframework/FenixFramework.html#initialize(pt.ist.fenixframework.Config)"><CODE>initialize(Config)</CODE></A>.
The syntax for the configuration file is to have each line in the form:
<blockquote>
<code>property=value</code>
</blockquote>
where each <code>property</code> must be the name of an existing configuration field.
Additionally, there is one optional special property named <code>config.class</code>. By
default, the config parser creates an instance of the <A HREF="../../../pt/ist/fenixframework/backend/BackEndId.html#getDefaultConfigClass()"><CODE>BackEndId.getDefaultConfigClass()</CODE></A>
provided by the current BackEndId, but this property can be used to choose a different (albeit
compatible) configuration class. The config instance is then populated with each property
(except with the <code>config.class</code> property), using the following algorithm:
<ol>
<li> Confirm that the config has a field with the same name as the <code>property</code>. If not
a <A HREF="../../../pt/ist/fenixframework/ConfigError.html" title="class in pt.ist.fenixframework"><CODE>ConfigError</CODE></A> is thrown.</li>
<li> If the config class provides a method (can be private) in the format
<code><property>FromString(String)</code>, then such method will be invoked to set the
property. The <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><CODE>String</CODE></A> argument will be the <code>value</code>.</li>
<li> Else, attempt to directly set the property on the field assigning it the <code>value</code>
String.</li>
<li> If all previous attempts have failed, throw a <A HREF="../../../pt/ist/fenixframework/ConfigError.html" title="class in pt.ist.fenixframework"><CODE>ConfigError</CODE></A>.</li>
</ol>
<p>The rationale supporting the previous mechanism is to allow the config class to process the
String provided in the <code>value></code> using the <code>*FromString</code> method.
<p> After population of the config finishes with success, the <A HREF="../../../pt/ist/fenixframework/FenixFramework.html#initialize(pt.ist.fenixframework.Config)"><CODE>initialize(Config)</CODE></A> method is invoked with the created Config instance. From this
point on, the initialization process continues just as if the programmer had explicitly invoked
that initialization method.
<p>The explicit configuration maintains the original configuration style (since Fenix Framework
1.0) with compile-time checking of the config's attributes. To use it, read the documentation in
the <A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework"><CODE>Config</CODE></A> class. It also adds the possibility for the programmer to provide multiple
configurations and then let the initialization process decide which to use based on the current
<A HREF="../../../pt/ist/fenixframework/backend/BackEnd.html" title="interface in pt.ist.fenixframework.backend"><CODE>BackEnd</CODE></A> (see <A HREF="../../../pt/ist/fenixframework/MultiConfig.html" title="class in pt.ist.fenixframework"><CODE>MultiConfig</CODE></A> for more details).
<p>After initialization completes with success, the framework is ready to manage operations on
the domain objects. Also, it is possible to get an instance of the <A HREF="../../../pt/ist/fenixframework/dml/DomainModel.html" title="class in pt.ist.fenixframework.dml"><CODE>DomainModel</CODE></A> class
representing the structure of the application's domain.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework"><CODE>Config</CODE></A>,
<A HREF="../../../pt/ist/fenixframework/dml/DomainModel.html" title="class in pt.ist.fenixframework.dml"><CODE>DomainModel</CODE></A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#FenixFramework()">FenixFramework</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework">Config</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#getConfig()">getConfig</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../pt/ist/fenixframework/dml/DomainModel.html" title="class in pt.ist.fenixframework.dml">DomainModel</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#getDomainModel()">getDomainModel</A></B>()</CODE>
<BR>
Gets the model of the domain classes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T extends <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework">DomainObject</A>>
<BR>
T</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#getDomainObject(java.lang.String)">getDomainObject</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> externalId)</CODE>
<BR>
Get any <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework"><CODE>DomainObject</CODE></A> given its external identifier.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../pt/ist/fenixframework/DomainRoot.html" title="class in pt.ist.fenixframework">DomainRoot</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#getDomainRoot()">getDomainRoot</A></B>()</CODE>
<BR>
Always gets a well-known singleton instance of <A HREF="../../../pt/ist/fenixframework/DomainRoot.html" title="class in pt.ist.fenixframework"><CODE>DomainRoot</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../pt/ist/fenixframework/Transaction.html" title="interface in pt.ist.fenixframework">Transaction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#getTransaction()">getTransaction</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../pt/ist/fenixframework/TransactionManager.html" title="interface in pt.ist.fenixframework">TransactionManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#getTransactionManager()">getTransactionManager</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#initialize(pt.ist.fenixframework.Config)">initialize</A></B>(<A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework">Config</A> newConfig)</CODE>
<BR>
This method initializes the FenixFramework.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#initialize(pt.ist.fenixframework.MultiConfig)">initialize</A></B>(<A HREF="../../../pt/ist/fenixframework/MultiConfig.html" title="class in pt.ist.fenixframework">MultiConfig</A> configs)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#isInitialized()">isInitialized</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../pt/ist/fenixframework/FenixFramework.html#shutdown()">shutdown</A></B>()</CODE>
<BR>
Inform the framework components that the application intends to shutdown.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="FenixFramework()"><!-- --></A><H3>
FenixFramework</H3>
<PRE>
public <B>FenixFramework</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isInitialized()"><!-- --></A><H3>
isInitialized</H3>
<PRE>
public static boolean <B>isInitialized</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>whether the <code>FenixFramework.initialize</code> method has
already been invoked</DL>
</DD>
</DL>
<HR>
<A NAME="initialize(pt.ist.fenixframework.Config)"><!-- --></A><H3>
initialize</H3>
<PRE>
public static void <B>initialize</B>(<A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework">Config</A> newConfig)</PRE>
<DL>
<DD>This method initializes the FenixFramework. It must be the first method
to be called, and it should be invoked only once. It needs to be called
before starting to access any Transactions/DomainObjects, etc.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newConfig</CODE> - The configuration that will be used by this instance of the framework.</DL>
</DD>
</DL>
<HR>
<A NAME="initialize(pt.ist.fenixframework.MultiConfig)"><!-- --></A><H3>
initialize</H3>
<PRE>
public static void <B>initialize</B>(<A HREF="../../../pt/ist/fenixframework/MultiConfig.html" title="class in pt.ist.fenixframework">MultiConfig</A> configs)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfig()"><!-- --></A><H3>
getConfig</H3>
<PRE>
public static <A HREF="../../../pt/ist/fenixframework/Config.html" title="class in pt.ist.fenixframework">Config</A> <B>getConfig</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDomainModel()"><!-- --></A><H3>
getDomainModel</H3>
<PRE>
public static <A HREF="../../../pt/ist/fenixframework/dml/DomainModel.html" title="class in pt.ist.fenixframework.dml">DomainModel</A> <B>getDomainModel</B>()</PRE>
<DL>
<DD>Gets the model of the domain classes. Should only be invoked after the framework is
initialized.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The current <A HREF="../../../pt/ist/fenixframework/dml/DomainModel.html" title="class in pt.ist.fenixframework.dml"><CODE>DomainModel</CODE></A> in use.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../pt/ist/fenixframework/ConfigError.html" title="class in pt.ist.fenixframework">ConfigError</A></CODE> - If this method is invoked before the framework is initialized or if a
<A HREF="../../../pt/ist/fenixframework/dml/DmlCompilerException.html" title="class in pt.ist.fenixframework.dml"><CODE>DmlCompilerException</CODE></A> occurs (only possible on first invocation).</DL>
</DD>
</DL>
<HR>
<A NAME="getDomainRoot()"><!-- --></A><H3>
getDomainRoot</H3>
<PRE>
public static <A HREF="../../../pt/ist/fenixframework/DomainRoot.html" title="class in pt.ist.fenixframework">DomainRoot</A> <B>getDomainRoot</B>()</PRE>
<DL>
<DD>Always gets a well-known singleton instance of <A HREF="../../../pt/ist/fenixframework/DomainRoot.html" title="class in pt.ist.fenixframework"><CODE>DomainRoot</CODE></A>. The intended use of this
instance is to provide a single entry point to the graph of <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework"><CODE>DomainObject</CODE></A>s. The user
of the framework may connect (via DML) any <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework"><CODE>DomainObject</CODE></A> to this class.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDomainObject(java.lang.String)"><!-- --></A><H3>
getDomainObject</H3>
<PRE>
public static <T extends <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework">DomainObject</A>> T <B>getDomainObject</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> externalId)</PRE>
<DL>
<DD>Get any <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework"><CODE>DomainObject</CODE></A> given its external identifier.
The external identifier must have been obtained by a previous invocation to <A HREF="../../../pt/ist/fenixframework/DomainObject.html#getExternalId()"><CODE>DomainObject.getExternalId()</CODE></A>. If the external identifier is tampered with (in which case a
valid <A HREF="../../../pt/ist/fenixframework/DomainObject.html" title="interface in pt.ist.fenixframework"><CODE>DomainObject</CODE></A> cannot be found), the result of calling this method is undefined.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>externalId</CODE> - The external identifier of the domain object to get
<DT><B>Returns:</B><DD>The domain object requested</DL>
</DD>
</DL>
<HR>
<A NAME="getTransactionManager()"><!-- --></A><H3>
getTransactionManager</H3>
<PRE>
public static <A HREF="../../../pt/ist/fenixframework/TransactionManager.html" title="interface in pt.ist.fenixframework">TransactionManager</A> <B>getTransactionManager</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTransaction()"><!-- --></A><H3>
getTransaction</H3>
<PRE>
public static <A HREF="../../../pt/ist/fenixframework/Transaction.html" title="interface in pt.ist.fenixframework">Transaction</A> <B>getTransaction</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="shutdown()"><!-- --></A><H3>
shutdown</H3>
<PRE>
public static void <B>shutdown</B>()</PRE>
<DL>
<DD>Inform the framework components that the application intends to shutdown. This allows for an
orderly termination of any running components. The default implementation delegates to the
backend the task of shutting down the framework. After invoking this method there is no
guarantee that the Fenix Framework is able to provide any more services.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FenixFramework.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../pt/ist/fenixframework/DomainRoot_Base.html" title="class in pt.ist.fenixframework"><B>PREV CLASS</B></A>
<A HREF="../../../pt/ist/fenixframework/MultiConfig.html" title="class in pt.ist.fenixframework"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?pt/ist/fenixframework/FenixFramework.html" target="_top"><B>FRAMES</B></A>
<A HREF="FenixFramework.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2013. All Rights Reserved.
</BODY>
</HTML>