User: dimc Date: 02/02/25 03:43:06 Modified: core/docs castor.html Log: Added patches submitted by Bart Guijt. Revision Changes Path 1.4 +52 -9 xdoclet/core/docs/castor.html Index: castor.html =================================================================== RCS file: /cvsroot/xdoclet/xdoclet/core/docs/castor.html,v retrieving revision 1.3 retrieving revision 1.4 diff -u -w -r1.3 -r1.4 --- castor.html 22 Jan 2002 23:47:53 -0000 1.3 +++ castor.html 25 Feb 2002 11:43:06 -0000 1.4 @@ -8,8 +8,8 @@ <h3>Castor</h3> -<p>The castormapping subtask produces a <i>mapping.xml</i> file for use by castor. It is a subtask of the <a -href="ejbdoclet.html">ejbdoclet</a> task.</p> +<p>The castormapping subtask produces a <i>mapping.xml</i> file for use by castor. It is a subtask of the +<a href="ejbdoclet.html">ejbdoclet</a> task.</p> <h4>Parameters</h4> @@ -39,6 +39,9 @@ <p>Defines the class and its attributes.</p> +<p>For full coverage of the mapping options, please refer to the +<a href="http://castor.exolab.org/xml-mapping.html";>Castor Mapping documentation</a>.</p> + <table border="1" cellpadding="7"> <tr valign="top"> <td>Parameter</td> @@ -65,7 +68,8 @@ </tr> <tr> <td><i>[extends]</i>: String</td> - <td>The castor superclass of this class.</td> + <td>Should be used <b>only</b> if this class extends another class for which mapping information + is provided. It should <b>not</b> be used if the extended class is not used in the mapping file.</td> </tr> <tr> <td><i>[key-generator]</i>: String</td> @@ -73,7 +77,8 @@ </tr> <tr> <td><i>[auto-complete]</i>: "true" | "false"</td> - <td>?</td> + <td>If <i>true</i>, the class will be introspected to determine its field and the fields + specified in the mapping file will be used to overide the field found during the introspection.</td> </tr> </table> @@ -87,16 +92,40 @@ <td>Usage</td> </tr> <tr valign="top"> + <td><i>[type]</i>: String</td> + <td>The Java type of the field. It is used to access the field. Castor will use this information + to cast the XML information (like string into integer). It is also used to define the signature + of the accessors method. If a collection is specified, this is used to specify the type of the + object inside the collection.<br /> + If <i>type</i> is not specified it defaults to the return type of the method.<br /> + <b>WARNING:</b> You need to specify the <i>type</i> explicitly if the return type is an 'int' + (specify the value 'integer') or if the return type is an array (specify the type without brackets).</td> + </tr> + <tr valign="top"> <td><i>[required]</i>: "true" | "false"</td> <td>Flag to indicate if the field is compulsory.</td> </tr> <tr valign="top"> + <td><i>[direct]</i>: "true" | "false"</td> + <td>Flag to indicate if the field should be accessed directly rather + than using getter / setter methods.</td> + </tr> + <tr valign="top"> <td><i>[lazy]</i>: "true" | "false"</td> <td>Flag to indicate if the field loaded lazily.</td> </tr> <tr valign="top"> + <td><i>[transient]</i>: "true" | "false"</td> + <td>Flag to indicate if the field should be ignored during marshalling - + usefull when used with the <i>auto-complete</i> option of <i>@castor:class</i>.</td> + </tr> + <tr valign="top"> + <td><i>[set-method]</i>: String</td> + <td>The method used to set the property value.</td> + </tr> + <tr valign="top"> <td><i>[create-method]</i>: String</td> - <td>?</td> + <td>The factory method for instantiation of FieldHandler.</td> </tr> <tr valign="top"> <td><i>[collection]</i>: "array" | @@ -148,21 +177,35 @@ </tr> <tr valign="top"> <td><i>[name]</i>: String</td> - <td>The node name.</td> + <td>The name of the element or attribute.</td> </tr> <tr valign="top"> <td><i>[type]</i>: String</td> - <td>The field's XML type.</td> + <td>XML Schema type (of the value of this field) that requires specific handling + in the Castor Marshalling Framework (such as 'QName' for instance).</td> </tr> <tr valign="top"> <td><i>[matches]</i>: String</td> - <td>?</td> + <td>Allows overriding the matches rules for the name of the element. + It is a standard regular expression and will be used instead of the 'name' field.</td> + </tr> + <tr valign="top"> + <td><i>[QName-prefix]</i>: String</td> + <td>When using a QName value, you can provide a default prefix that is used when + marshalling value of type QName.</td> + </tr> + <tr valign="top"> + <td><i>[reference]</i>: "true" | "false"</td> + <td>Indicates if this field has to be treated as a reference by the unmarshaller. + In order to work properly, you must specify the <i>node</i> type to 'attribute' for both + the 'id' and the 'reference' fields.</td> </tr> <tr valign="top"> <td><i>[node]</i>: "element" | "attribute" | "text"</td> - <td>The type of node the field should be represented as.</td> + <td>Indicates if the name corresponds to an attribute, an element, or text content. By default, + primitive types are assumed to be an attribute otherwise the node is assumed to be an element.</td> </tr> </table>
_______________________________________________ Xdoclet-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
