User: pazu
Date: 02/04/25 08:01:46
Modified: core/docs ejbdoclet_toc.html jboss.html
Log:
Documentation updates. JBoss documentation is now
updated to the current features. Depracated tags
have been removed from the TOC, but kept in the
detail file.
Revision Changes Path
1.27 +20 -10 xdoclet/core/docs/ejbdoclet_toc.html
Index: ejbdoclet_toc.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/ejbdoclet_toc.html,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -w -r1.26 -r1.27
--- ejbdoclet_toc.html 16 Apr 2002 23:01:05 -0000 1.26
+++ ejbdoclet_toc.html 25 Apr 2002 15:01:46 -0000 1.27
@@ -103,24 +103,34 @@
</UL>
<H4>JBoss</H4>
<UL>
+ <!-- Deprecated tags have been removed from the TOC -->
<LI><A HREF="jboss.html#cmp-field">@jboss:cmp-field</A>
- <LI><A HREF="jboss.html#column-name">@jboss:column-name</A>
- <LI><A
HREF="jboss.html#container-configuration">@jboos:container-configuration</A>
- <LI><A HREF="jboss.html#create-table">@jboss:create-table</A>
+ <!-- <LI><A HREF="jboss.html#column-name">@jboss:column-name</A> -->
+ <LI><A
HREF="jboss.html#container-configuration">@jboss:container-configuration</A>
+ <!-- <LI><A HREF="jboss.html#create-table">@jboss:create-table</A> -->
+ <LI><A HREF="jboss.html#declared-sql">@jboss:declared-sql</A>
<LI><A HREF="jboss.html#destination-jndi-name">@jboss:destination-jndi-name</A>
+ <LI><A HREF="jboss.html#dvc">@jboss:dvc</A>
+ <LI><A HREF="jboss.html#dvc-property">@jboss:dvc-property</A>
<LI><A HREF="jboss.html#ejb-ref-jndi">@jboss:ejb-ref-jndi</A>
<LI><A HREF="jboss.html#finder-query">@jboss:finder-query</A>
- <LI><A HREF="jboss.html#jdbc-type">@jboss:jdbc-type</A>
+ <!-- <LI><A HREF="jboss.html#jdbc-type">@jboss:jdbc-type</A> -->
<LI><A HREF="jboss.html#not-persisted-field">@jboss:not-persisted-field</A>
- <LI><A HREF="jboss.html#read-only">@jboss:read-only</A>
+ <LI><A HREF="jboss.html#persistence-class">@jboss:persistence</A>
+ <LI><A HREF="jboss.html#query">@jboss:query</A>
+ <LI><A HREF="jboss.html#read-ahead">@jboss:read-ahead</A>
+ <!-- <LI><A HREF="jboss.html#read-only">@jboss:read-only</A> -->
<LI><A HREF="jboss.html#relation">@jboss:relation</A>
- <LI><A HREF="jboss.html#remove-table">@jboss:remove-table</A>
+ <LI><A HREF="jboss.html#relation-mapping">@jboss:relation-mapping</A>
+ <LI><A HREF="jboss.html#relation-table">@jboss:relation-table</A>
+ <!-- <LI><A HREF="jboss.html#remove-table">@jboss:remove-table</A> -->
<LI><A HREF="jboss.html#resource-manager">@jboss:resource-manager</A>
<LI><A HREF="jboss.html#resource-ref">@jboss:resource-ref</A>
- <LI><A HREF="jboss.html#sql-type">@jboss:sql-type</A>
- <LI><A HREF="jboss.html#table-name">@jboss:table-name</A>
- <LI><A HREF="jboss.html#time-out">@jboss:time-out</A>
- <LI><A HREF="jboss.html#tuned-updates">@jboss:tuned-updates</A>
+ <!-- <LI><A HREF="jboss.html#sql-type">@jboss:sql-type</A> -->
+ <!-- <LI><A HREF="jboss.html#table-name">@jboss:table-name</A> -->
+ <LI><A HREF="jboss.html#relation">@jboss:target-relation</A>
+ <!-- <LI><A HREF="jboss.html#time-out">@jboss:time-out</A> -->
+ <!-- <LI><A HREF="jboss.html#tuned-updates">@jboss:tuned-updates</A> -->
</UL>
<H4>JRun</H4>
<UL>
1.14 +248 -71 xdoclet/core/docs/jboss.html
Index: jboss.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/jboss.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -w -r1.13 -r1.14
--- jboss.html 16 Apr 2002 23:01:05 -0000 1.13
+++ jboss.html 25 Apr 2002 15:01:46 -0000 1.14
@@ -1,4 +1,3 @@
-<html>
<head>
<title>XDoclet - JBoss</title>
</head>
@@ -8,7 +7,7 @@
<h3>jboss</h3>
-<p>Creates JBoss-specific deployment descriptors (jboss.xml and jaws.xml
+<p>Creates JBoss-specific deployment descriptors (jboss.xml, jaws.xml and
jbosscmp-jdbc.xml
files) for EJB beans.</p>
<h4>Parameters</h4>
@@ -110,49 +109,42 @@
<td>The file where container configurations are defined</td>
<td>No</td>
</tr>
- </table>
-</div>
-
-<p>Remember you should preserve the package directory structure in mergedir. If
-the bean is test.bank.AccountBean then jboss-Account.xml should be
-located at test/bank directory in mergedir.</p>
-
-<h4>Merge points</h4>
-<table border="1" cellspacing="0">
-<tr>
-<td><b>Merge File Name</b></td><td><b>Description</b></td><td><b>Required</b></td>
-</tr>
-<tr>
-<td>jaws-db-settings-{0}.xml</td>
-<td>The file where per-bean jaws settings are defined {0} designates EJB name</td>
+ <tr valign="top">
+ <td>jbosscmp-jdbc-defaults.xml</td>
+ <td>The file where JBossCMP defaults are defined</td>
<td>No</td>
</tr>
-<tr>
-<td>jaws-{0}.xml</td>
-<td>The file where per-field jaws settings are defined {0} designates EJB name</td>
+ <tr valign="top">
+ <td>jbosscmp-jdbc-db-setting-{0}.xml</td>
+ <td>The file where per-bean JBossCMP database settings are defined</td>
<td>No</td>
</tr>
-<tr>
-<td>jboss-security.xml</td>
-<td>The file where security settings for the beans are defined (security domain
etc.)</td>
+ <tr valign="top">
+ <td>jbosscmp-jdbc-{0}.xml</td>
+ <td>The file where per-ben JBossCMP CMP settings are defined</td>
<td>No</td>
</tr>
-<tr>
-<td>jboss-{0}.xml</td>
-<td>The file where per-bean jboss settings are defined ( jndi names, resource refs
etc. ). {0} designates EJB name</td>
+ <tr valign="top">
+ <td>jbosscmp-jdbc-load-{0}.xml</td>
+ <td>The file where per-bean JBossCMP load groups are defined</td>
<td>No</td>
</tr>
-<tr>
-<td>jboss-resource-managers.xml</td>
-<td>The file where resource managers are defined</td>
+ <tr valign="top">
+ <td>jbosscmp-jdbc-dvc.xml</td>
+ <td>The file where DVC classes are defined</td>
<td>No</td>
</tr>
-<tr>
-<td>jboss-container.xml</td>
-<td>The file where resource container configurations are defined</td>
+ <tr valign="top">
+ <td>jbosscmp-jdbc-typemappings.xml</td>
+ <td>The file where JBossCMP custom typemappings are defined</td>
<td>No</td>
</tr>
</table>
+</div>
+
+<p>Remember you should preserve the package directory structure in mergedir. If
+the bean is test.bank.AccountBean then jboss-Account.xml should be
+located at test/bank directory in mergedir.</p>
<h3><a name="class-level-tags">Class level Tags</a></h3>
@@ -172,9 +164,7 @@
</tr>
</table>
-<h4><a name="read-only">@jboss:read-only</a></h4>
-
-<p>Mark bean as read-only. This will avoid ejbStore calls.</p>
+<h4><a name="read-only">[DEPRECATED in favour of <a
href="#persistence-class">@jboss:persistence</a>] @jboss:read-only</a></h4>
<table border="1" cellpadding="7">
<tr valign="top">
@@ -251,7 +241,7 @@
</tr>
</table>
-<h4><a name="table-name">@jboss:persistence</a></h4>
+<h4><a name="persistence-class">@jboss:persistence</a></h4>
<p>The Jaws/Jboss CMP deployment descriptor specific entries.</p>
@@ -259,50 +249,80 @@
<tr valign="top">
<td>Parameter</td>
<td>Usage</td>
+ <td>Mandatory</td>
</tr>
<tr valign="top">
<td><i>[datasource]</i>: String</td>
- <td> </td>
+ <td>JNDI name of the datasource to be used for this bean.</td>
+ <td>No. If specified, datasource-mapping should also be specified.</td>
</tr>
<tr valign="top">
<td><i>[datasource-mapping]</i>: String</td>
- <td> </td>
+ <td>Typemapping for the datasource to be used for this bean.</td>
+ <td>No. If specified, datasource should also be specified.</td>
</tr>
<tr valign="top">
- <td><i>[create]</i>: String</td>
- <td> </td>
+ <td><i>[create-table]</i>: "true" | "false"</td>
+ <td>Set to true if you want JBoss to create the entity table when the bean is
deployed.</td>
+ <td>No. Default is taken from container configuration (usually true).</td>
</tr>
<tr valign="top">
- <td><i>[remove]</i>: String</td>
- <td> </td>
+ <td><i>[remove-table]</i>: "true" | "false"</td>
+ <td>Set to true if you want JBoss to remove the entity table when the bean is
undeployed.</td>
+ <td>No. Default is taken from container configuration (usually false).</td>
</tr>
<tr valign="top">
- <td><i>[tuned]</i>: String</td>
- <td> </td>
+ <td><i>[read-only]</i>: "true" | "false"</td>
+ <td>If true then the bean is read-only and no properties can be set. Avoid
database calls.</td>
+ <td>No. Default is taken from container configuration (usually false).</td>
</tr>
<tr valign="top">
- <td><i>[read-only]</i>: String</td>
- <td> </td>
+ <td><i>[time-out]</i>: milisseconds</td>
+ <td>Specify the amount of time that a read-only field is considered valid.</td>
+ <td>No. Default is taken from container configuration (usually 300).</td>
</tr>
<tr valign="top">
- <td><i>[time-out]</i>: String</td>
- <td> </td>
+ <td><i>[row-locking]</i>: "true" | "false"</td>
+ <td>Set to true if you want JBoss to use SELECT ... FOR UPDATE queries.</td>
+ <td>No. Default is taken from container configuration (usually false).</td>
</tr>
<tr valign="top">
- <td><i>[pk-constraint]</i>: String</td>
- <td> </td>
+ <td><i>[pk-constraint]</i>: "true" | "false"</td>
+ <td>Set to true if you want JBoss to create primary key constraints when
creating the entity table.</td>
+ <td>No. Default is taken from container configuration (usually true).</td>
</tr>
<tr valign="top">
- <td><i>[select-for-update]</i>: String</td>
- <td>JBoss 2.4 / JBoss-Jaws 3.0</td>
+ <td><i>[list-cache-max]</i>: integer</td>
+ <td>Specifies the number of simultaneous queries that can be tracked by the
cache for the entity.</td>
+ <td>No. Default is taken from container configuration (usually 1000).</td>
+</table>
+
+<h4><a name="read-ahead">@jboss:read-ahead</a></h4>
+<p>JBossCMP read-ahead configuration</p>
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ <td>Mandatory</td>
+ </tr>
+ <tr valign="top">
+ <td>strategy: on-load/on-find</td>
+ <td>The strategy used to read-ahead data in queries.</td>
+ <td>Yes</td>
</tr>
<tr valign="top">
- <td><i>[row-locking]</i>: String</td>
- <td>JBoss-CMP 3.0</td>
+ <td><i>[page-size]</i>: integer</td>
+ <td>The number of entities that will be read in a single read-ahead load
query.</td>
+ <td>No. Default is taken from container configuration (usually 1000).</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[eager-load-group]</i>: string</td>
+ <td>The name of the load-group that should be loaded on the read-ahead load
queries.</td>
+ <td>No. Default is taken from container configuration (usually *).</td>
</tr>
</table>
-<h4><a name="table-name">[DEPRECATED in favour of @ejb:persistence]
@jboss:table-name</a></h4>
+<h4><a name="table-name">[DEPRECATED in favour of <a
href="ejb.html#persistence-class">@ejb:persistence</a>] @jboss:table-name</a></h4>
<p>The table to be used by this bean is called <i>table-name</i>.
Applicable to entity beans using JAWS for CMP.</p>
@@ -318,7 +338,7 @@
</tr>
</table>
-<h4><a name="create-table">[DEPRECATED in favour of @jboss:persistence]
@jboss:create-table</a></h4>
+<h4><a name="create-table">[DEPRECATED in favour of <a
href="#persistence-class">@jboss:persistence</a>] @jboss:create-table</a></h4>
<a>Create the table if it doesn't exist. Applicable to entity beans using JAWS for
CMP.</a>
@@ -333,7 +353,7 @@
</tr>
</table>
-<h4><a name="remove-table">[DEPRECATED in favour of @jboss:persistence]
@jboss:remove-table</a></h4>
+<h4><a name="remove-table">[DEPRECATED in favour of <a
href="#persistence-class">@jboss:persistence</a>] @jboss:remove-table</a></h4>
<a>Remove the table when the bean is undeployed. Applicable to entity beans using
JAWS for CMP.</a>
@@ -348,7 +368,22 @@
</tr>
</table>
-<h4><a name="tuned-updates">[DEPRECATED in favour of @jboss:persistence]
@jboss:tuned-updates</a></h4>
+<h4><a name="remove-table">[DEPRECATED in favour of <a
href="#persistence-class">@jboss:persistence</a>] @jboss:pk-constraint</a></h4>
+
+<a>Create a primary constraint when creating the table</a>
+
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[pk-constraint]</i>: "true" | "false"</td>
+ <td>Creates a pk constraint when creating the table.</td>
+ </tr>
+</table>
+
+<h4><a name="tuned-updates">[DEPRECATED in favour of <a
href="#persistence-class">@jboss:persistence</a>] @jboss:tuned-updates</a></h4>
<p>Use tuned updates (i.e. minimize data stored on ejbStore). Applicable to entity
beans using JAWS for CMP.</p>
@@ -363,7 +398,7 @@
</tr>
</table>
-<h4><a name="time-out">[DEPRECATED in favour of @jboss:persistence]
@jboss:time-out</a></h4>
+<h4><a name="time-out">[DEPRECATED in favour of <a
href="#persistence-class">@jboss:persistence</a>] @jboss:time-out</a></h4>
<p>Time out for read-only beans. The state of the bean will be
reloaded from the database after the time out. Applicable to entity
@@ -412,6 +447,63 @@
</tr>
</table>
+<h4><a name="query">@jboss:query</a></h4>
+<p>Assign a JBoss-QL or Dynamic-QL element to a finder.</p>
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ </tr>
+ <tr valign="top">
+ <td>signature: String</td>
+ <td>The method signature for this finder. Must match the signature
+ in ejb-jar.xml (genereted using @ejb:finder).</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[query]</i>: String</td>
+ <td>Specify the JBoss-QL for this finder. JBoss-QL is an extension to
EJB-QL.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[dynamic-ql]: String</td>
+ <td>Mark this finder as a method that takes a Dynamic-QL argument. More info on
+ the JBossCMP documentation.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[result-type-mapping]</i>: "Local" | "Remote"</td>
+ <td>The result type for a collection-valued finder.</td>
+ </tr>
+</table>
+
+<h4><a name="declared-sql">@jboss:declared-sql</a></h4>
+<p>Declares the SQL for a finder.</p>
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ </tr>
+ <tr valign="top">
+ <td>signature: String</td>
+ <td>The method signature for this finder. Must match the signature
+ in ejb-jar.xml (genereted using @ejb:finder).</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[where]</i>: String</td>
+ <td>The WHERE clause for the declared SQL.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[order]: String</td>
+ <td>The ORDER BY clause for the declared SQL.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[other]: String</td>
+ <td>Any aditional words for the declared SQL.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[result-type-mapping]</i>: "Local" | "Remote"</td>
+ <td>The result type for a collection-valued finder.</td>
+ </tr>
+</table>
+
<h4><a name="cmp-field">@jboss:cmp-field</a></h4>
<p>Will define a <cmp-field> element for a field of a cmp-field
@@ -453,9 +545,15 @@
</tr>
</table>
+<h4><a name="dvc">@jboss:dvc</a></h4>
+
+<p>JBossCMP Dependent Value Class configuration. Just put this tag on a class if you
+want to generate o <dependent-value-class/> section for this class. Also, you need
to
+tag each property you want persisted with <a
href="#dvc-property">@jboss:dvc-property</a>.
+
<h3><a name="method-level-tags">Method level Tags</h3>
-<h4><a name="column-name">[DEPRECATED in favour of @ejb:persistence]
@jboss:column-name</a></h4>
+<h4><a name="column-name">[DEPRECATED in favour of <a
href="ejb.html#persistence-method">@ejb:persistence</a>] @jboss:column-name</a></h4>
<p>The column name for the CMP field in the table where this bean will
be persisted. Applicable to Entity EJBs using JAWS CMP.</p>
@@ -471,7 +569,7 @@
</tr>
</table>
-<h4><a name="sql-type">[DEPRECATED in favour of @ejb:persistence]
@jboss:sql-type</a></h4>
+<h4><a name="sql-type">[DEPRECATED in favour of <a
href="ejb.html#persistence-method">@ejb:persistence</a>] @jboss:sql-type</a></h4>
<p>The SQL type for the column where this CMP field will be
persisted. See your database's documentation for a list of valid
@@ -489,7 +587,7 @@
</tr>
</table>
-<h4><a name="jdbc-type">[DEPRECATED in favour of @ejb:persistence]
@jboss:jdbc-type</a></h4>
+<h4><a name="jdbc-type">[DEPRECATED in favour of <a
href="ejb.html">@ejb:persistence</a>] @jboss:jdbc-type</a></h4>
<p>The JDBC type for the column where this CMP field will be
persisted. See the javadoc for "java.sql.Types" for a list of valid
@@ -515,11 +613,34 @@
href="#cmp-field"><code>@jboss:cmp-field</code></a>. Applicable to
Entity beans using JAWS CMP. This tag has no parameters.</p>
+<h4><a name="relation-mapping">@jboss:relation-mapping</a></h4>
+<p>Used to choose the relation mapping style for a relationship. It can
+be safely omitted and must be used only when you want a mapping style that
+is different from the default (foreign-key for 1-1 and 1-n relations,
+relation-table for n-m relations).</p>
+
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ </tr>
+ <tr valign="top">
+ <td><i>style</i>: (foreign-key | relation-table)</td>
+ <td>The mapping style for this relationship.</td>
+ </tr>
+</table>
+
+
<h4><a name="relation">@jboss:relation</a></h4>
<p>Used to customize the relationships via jbosscmp-jdbc.xml for JBoss 3.0.
NOTE: If you replace jboss:relation with jboss:target-relation, you can modify
the blind side of a unidirectional relationship (someone fix this wording)</p>
+<p>Also please note that the @jboss:relation semantics and the generated
<key-fields>
+generated element are somewhat reversed. You use @jboss:relation tag on the
relation side
+that has the foreign key, but the <key-fields> element is genereted on the
relation side
+that holds the primary key. This behavior <em>is correct</em>. Take a look at the
+samples so you can understand better what this means.</p>
<table border="1" cellpadding="7">
<tr valign="top">
@@ -539,6 +660,62 @@
<tr valign="top">
<td><i>fk-column</i>: (String)</td>
<td>Name of the column that should be used for foreign key mapping.
(Corresponds to column-name in jbosscmp-jdbc.xml)</td>
+ </tr>
+</table>
+
+<h4><a name="relation-table">@jboss:relation-table</a></h4>
+<p>Used to configure the table used in relation table mapped relationships.</p>
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ </tr>
+ <tr valign="top">
+ <td><i>table-name</i>: String</td>
+ <td>The name of the table used for this relationship.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[create-table]</i>: (true | false)</td>
+ <td>Set to true if you want JBossCMP to create the relation table at
deployment time.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[remove-table]</i>: (true | false)</td>
+ <td>Set to true if you want JBossCMP to remove the relation table at
undeployment time.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[pk-constraint]</i>: (true | false)</td>
+ <td>Set to true if you want JBossCMP to create a primary key
constraint on the relation table.</td>
+ </tr>
+</table>
+
+<h4><a name="dvc-property">@jboss:dvc-property</a></h4>
+
+<p>This tag has two possible uses. The first is on the DVC class to declare which
properties
+should be used as DVC fields and the second is on a CMR field to specify how to map
DVC properties to
+database columns. On a DVC property, this tag doesn't need any parameters. On a CMR
field you need
+to indicate at least property-name and can also define the column-name, jdbc-type
and sql-type.
+Please not that jdbc-type and sql-type should both on none be specified.</p>
+
+<table border="1" cellpadding="7">
+ <tr valign="top">
+ <td>Parameter</td>
+ <td>Usage</td>
+ </tr>
+ <tr valign="top">
+ <td>property-name: String</td>
+ <td>The name of the DVC property being configured.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[column-name]</i>: String</td>
+ <td>The database column where te persist this property.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[jdbc-type]</i>: String</td>
+ <td>The JDBC type for this property.</td>
+ </tr>
+ <tr valign="top">
+ <td><i>[sql-type]</i>: String</td>
+ <td>The SQL type for this property.</td>
</tr>
</table>
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
