Menu
▾
▴
[Andromdaplugins-cvs] CVS update: cartridges/andromda-ejb3/src/site/fml faq.fml
|
From: Vance K. <va...@us...> - 2006-06-28 02:58:40
|
User: vancek
Date: 06/06/27 19:58:35
Modified: andromda-ejb3/src/site/xdoc howto.xml howto20.xml
andromda-ejb3/src/site site.xml
andromda-ejb3/src/site/fml faq.fml
Log:
update docs
Revision Changes Path
1.21 +6 -1 cartridges/andromda-ejb3/src/site/xdoc/howto.xml
Index: howto.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/xdoc/howto.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -w -r1.20 -r1.21
--- howto.xml 26 Jun 2006 06:53:32 -0000 1.20
+++ howto.xml 28 Jun 2006 02:58:35 -0000 1.21
@@ -242,7 +242,12 @@
</p>
</li>
<li>
- <p><a href="howto20.html">Embeddable Value Objects</a></p>
+ <p>
+ <a href="howto20.html">Embeddable Value Objects</a>
+ <ul>
+ <li><p><a href="howto20.html#Helpful_Hints">Helpful Hints</a></p></li>
+ </ul>
+ </p>
</li>
</ul>
</p>
1.4 +26 -8 cartridges/andromda-ejb3/src/site/xdoc/howto20.xml
Index: howto20.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/xdoc/howto20.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -w -r1.3 -r1.4
--- howto20.xml 29 May 2006 01:53:36 -0000 1.3
+++ howto20.xml 28 Jun 2006 02:58:35 -0000 1.4
@@ -44,18 +44,36 @@
</ul>
</p>
<p>
- The cartridge provides basic support for embeddable value objects. Currently, no
- mapping annotations on properties of the embeddable value object are generated. This can easily
- be supported by modification to the <code>EJB3EmbeddedValueFacade</code> and corresponding
- <code>EmbeddedValue.vsl</code> template.
+ You can model basic features on your embeddable class attributes and these will be reflected in the
+ generated embeddable value object. These features are much the same as described in the
+ <a href="howto1.html">howto for entities</a>. The following is a brief list of annotations
+ and some properties that are available on embeddable attributes.
+ <ul>
+ <li><p>@Transient</p></li>
+ <li><p>@Version</p></li>
+ <li><p>@Lob with @Basic settings to fetch type</p></li>
+ <li><p>@Column with properties unique, nullable, insertable, updatable, length, columnDefinition, precision and scale</p></li>
+ <li><p>@Temporal</p></li>
+ <li><p>@Enumerated</p></li>
+ </ul>
</p>
<a name="Helpful_Hints"/>
<subsection name="Helpful Hints">
<p>
- Even though the EJB3 cartridge generates an implementation source file extending the
- auto generated embedded value object, the implementation is currently not used. Future
- version of the EJB3 cartridge will make use of the persistence ORM mapping file and will
- fix this issue.
+ The EJB3 cartridge now uses the persistence ORM mapping file <b>orm.xml</b> to declare the
+ embeddable class metadata. This means that the <code>@Embeddable</code> annotation is no longer
+ rendered in the base or implementation for the embeddable object.
+ The ORM mapping file defines the embeddable implementation, which extends the abstract embeddable
+ base object, as the embeddable class.
+ </p>
+ <p>
+ This has been adopted so that you can have an implementation for embeddable value object operations
+ or any other aspect requiring manual implementation, without having to be concerned with code
+ regeneration over-writing your implementation. This could not be achieved with pure annotations.
+ </p>
+ <p>
+ The cartridge now support having multiple attributes having the same embeddable value object type
+ within a single entity. There is limited support for associations between embeddable value objects.
</p>
</subsection>
</section>
1.16 +4 -2 cartridges/andromda-ejb3/src/site/site.xml
Index: site.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/site.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -w -r1.15 -r1.16
--- site.xml 17 Jun 2006 12:02:21 -0000 1.15
+++ site.xml 28 Jun 2006 02:58:35 -0000 1.16
@@ -12,8 +12,8 @@
<body>
<links>
<item name="EJB3" href="index.html"/>
- <item name="Cartridges" href="../andromda-cartridges/index.html"/>
- <item name="AndroMDA" href="../index.html"/>
+ <item name="Cartridges" href="http://galaxy.andromda.org/docs/andromda-cartridges/index.html"/>
+ <item name="AndroMDA" href="http://www.andromda.org"/>
</links>
<menu name="Overview">
<item name="About EJB3 Cartridge" href="index.html"/>
@@ -49,7 +49,9 @@
</menu>
<menu name="Support">
<item name="FAQ" href="faq.html"/>
+ <item name="Change Report" href="changes-report.html"/>
<item name="EJB Forum" href="http://galaxy.andromda.org/forum/viewforum.php?f=17"/>
+ <item name="JIRA EJB" href="http://galaxy.andromda.org/jira/browse/EJB"/>
</menu>
${reports}
</body>
1.2 +22 -0 cartridges/andromda-ejb3/src/site/fml/faq.fml
Index: faq.fml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/fml/faq.fml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- faq.fml 17 Jun 2006 12:02:21 -0000 1.1
+++ faq.fml 28 Jun 2006 02:58:35 -0000 1.2
@@ -40,5 +40,27 @@
</p>
</answer>
</faq>
+ <faq id="use_of_orm.xml">
+ <question>How does an EJB 3.0 project define meta information?</question>
+ <answer>
+ <p>
+ The cartridge now uses a combination of annotations and orm.xml deployment descriptor to define
+ meta mapping information. The orm.xml will override or even replace certain annotations and allows
+ you to maintain full control by separating generated code and your implementation code.
+ </p>
+ </answer>
+ </faq>
+ <faq id="how_to_stay_up_to_date">
+ <question>How can I stay up to date with the changes to the EJB3 cartridge?</question>
+ <answer>
+ <p>
+ The first thing you should do is register with the AndroMDA forums and select the forums you want to
+ keep your eye on to receive emails of posts.
+ </p>
+ <p>
+ Regularly read the updates in the <a href="changes-report.html">changes report</a>.
+ </p>
+ </answer>
+ </faq>
</part>
</faqs>
|
