Update of /cvsroot/xdoclet/xdoclet/modules/jdo/src/META-INF In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5871/modules/jdo/src/META-INF
Modified Files: xtags.xml Log Message: - xtags.xml: Replaced all ' by ' and all " by " - Tag 'jdo.fetch-group': Attributes 'field-names' and 'fetch-group-names' are deprecated now and replaced by 'fields' and 'fetch-groups'. Index: xtags.xml =================================================================== RCS file: /cvsroot/xdoclet/xdoclet/modules/jdo/src/META-INF/xtags.xml,v retrieving revision 1.25 retrieving revision 1.26 diff -C2 -r1.25 -r1.26 *** xtags.xml 18 Sep 2005 23:37:51 -0000 1.25 --- xtags.xml 19 Sep 2005 17:19:57 -0000 1.26 *************** *** 5,9 **** <namespace> <name>jdo</name> ! <usage-description>JDO tags used to generate jdo xml metadata. The tag names are identical to the element names in jdo.dtd.</usage-description> <condition-description>classes to be persistence-capable on class and field level</condition-description> <condition type="or"> --- 5,12 ---- <namespace> <name>jdo</name> ! <usage-description> ! JDO tags used to generate jdo xml metadata. ! The tag names are identical to the element names in jdo.dtd. ! </usage-description> <condition-description>classes to be persistence-capable on class and field level</condition-description> <condition type="or"> *************** *** 65,72 **** <name>jdo.persistence-capable</name> <usage-description> ! The jdo.persistence-capable tag provides information about the JDO persistent bean. Its presence determines if your class will be included in the generated jdo metadata. </usage-description> <unique>true</unique> ! <condition-description>The presence of the jdo.persistence-capable tag determines if a class will be included in the generated jdo metadata and thus if it will be enhanced to PersistenceCapable</condition-description> <condition type="class"/> --- 68,79 ---- <name>jdo.persistence-capable</name> <usage-description> ! The jdo.persistence-capable tag provides information about the JDO persistent bean. ! Its presence determines if your class will be included in the generated jdo metadata. </usage-description> <unique>true</unique> ! <condition-description> ! The presence of the jdo.persistence-capable tag determines if a class will be included in ! the generated jdo metadata and thus if it will be enhanced to PersistenceCapable. ! </condition-description> <condition type="class"/> *************** *** 74,78 **** <name>identity-type</name> <usage-description> ! Specifies whether objects are uniquely identified by a jdo-implementation provided abstract identifier (datastore identity), accessible fields in the object (application identity), or not at all (nondurable identity). </usage-description> <mandatory>true</mandatory> --- 81,87 ---- <name>identity-type</name> <usage-description> ! Specifies whether objects are uniquely identified by a jdo-implementation provided abstract ! identifier (datastore identity), accessible fields in the object (application identity), or ! not at all (nondurable identity). </usage-description> <mandatory>true</mandatory> *************** *** 91,95 **** <parameter type="text"> <name>objectid-class</name> ! <usage-description>The fully-qualified class name for the application identity object id. Use only with application identity.</usage-description> <mandatory>false</mandatory> </parameter> --- 100,106 ---- <parameter type="text"> <name>objectid-class</name> ! <usage-description> ! The fully-qualified class name for the application identity object id. Use only with application identity. ! </usage-description> <mandatory>false</mandatory> </parameter> *************** *** 163,172 **** <usage-description> XDoclet can generate JDO objectid-classes for you. Simply add this tag and ! the clazz specified by '@jdo.persistence-capable objectid-class="clazz"' will be created. </usage-description> <unique>true</unique> <condition-description> ! Does only work if an objectid-class has been specified by '@jdo.persistence-capable objectid-class="clazz"'. </condition-description> <condition type="class"/> --- 174,184 ---- <usage-description> XDoclet can generate JDO objectid-classes for you. Simply add this tag and ! the clazz specified by '@jdo.persistence-capable objectid-class="clazz"' will be created. </usage-description> <unique>true</unique> <condition-description> ! Does only work if an objectid-class has been specified by ! '@jdo.persistence-capable objectid-class="clazz"'. </condition-description> <condition type="class"/> *************** *** 177,181 **** Specify a comma-separated list with the primary-key fields, if you want to force a certain order. If you omit this attribute, all the primary-key fields (the fields tagged by ! '@jdo.field primary-key="true"') are ordered alphabetically according to their names. All pk-fields which are missing in this list will follow in their alphabetic order after the ones which have been declared. For better readability, spaces are allowed. --- 189,193 ---- Specify a comma-separated list with the primary-key fields, if you want to force a certain order. If you omit this attribute, all the primary-key fields (the fields tagged by ! '@jdo.field primary-key="true"') are ordered alphabetically according to their names. All pk-fields which are missing in this list will follow in their alphabetic order after the ones which have been declared. For better readability, spaces are allowed. *************** *** 189,195 **** If you want your object-id-class to extend another class, you can specify a superclass by this attribute. Note, that you can pass this attribute to the ! subtask 'jdoobjectidgenerator' as well (e.g. 'jdoobjectidgenerator superclass="a.b.c.AnyClass"'). Hence you do not need to define it for each class if it is always the same. ! This tag-attribute has a higher priority and replaces the subtask's attribute. </usage-description> <mandatory>false</mandatory> --- 201,208 ---- If you want your object-id-class to extend another class, you can specify a superclass by this attribute. Note, that you can pass this attribute to the ! subtask 'jdoobjectidgenerator' as well ! (e.g. 'jdoobjectidgenerator superclass="a.b.c.AnyClass"'). Hence you do not need to define it for each class if it is always the same. ! This tag-attribute has a higher priority and replaces the subtask's attribute. </usage-description> <mandatory>false</mandatory> *************** *** 202,209 **** comma-separated list here. Note, that you are able to pass a comma-separated list of interfaces to the subtask as well: ! 'jdoobjectidgenerator interfaces="a.b.c.Interface1, d.e.f.Interface2"/' All interfaces ! which are declared by 'add-interfaces' will be appended to the declaration of the subtask. Note, that you must implement these interfaces yourself if they are not only tagging interfaces. ! You can do that by including a file via 'include-body'. </usage-description> <mandatory>false</mandatory> --- 215,222 ---- comma-separated list here. Note, that you are able to pass a comma-separated list of interfaces to the subtask as well: ! 'jdoobjectidgenerator interfaces="a.b.c.Interface1, d.e.f.Interface2"' All interfaces ! which are declared by 'add-interfaces' will be appended to the declaration of the subtask. Note, that you must implement these interfaces yourself if they are not only tagging interfaces. ! You can do that by including a file via 'include-body'. </usage-description> <mandatory>false</mandatory> *************** *** 213,219 **** <name>replace-interfaces</name> <usage-description> ! The attribute 'replace-interfaces' does basically the same as 'add-interfaces', but it ! overwrites any declaration that was passed to the subtask 'jdoobjectidgenerator' (while ! 'add-interfaces' appends). </usage-description> <mandatory>false</mandatory> --- 226,232 ---- <name>replace-interfaces</name> <usage-description> ! The attribute 'replace-interfaces' does basically the same as 'add-interfaces', but it ! overwrites any declaration that was passed to the subtask 'jdoobjectidgenerator' (while ! 'add-interfaces' appends). </usage-description> <mandatory>false</mandatory> *************** *** 226,233 **** you can create an include-file and specify it here. If you use a relative path (strongly recommended!), the path is relative to the class source file. This means, ! if you don't specify a directory at all, the include file must be located in the same directory as the class source file. ! It is recommended to name the include file 'MyObjectIDClass.body.inc'. ! If you need "imports" declarations, use 'include-imports'. </usage-description> <mandatory>false</mandatory> --- 239,246 ---- you can create an include-file and specify it here. If you use a relative path (strongly recommended!), the path is relative to the class source file. This means, ! if you don't specify a directory at all, the include file must be located in the same directory as the class source file. ! It is recommended to name the include file 'MyObjectIDClass.body.inc'. ! If you need "imports" declarations, use 'include-imports'. </usage-description> <mandatory>false</mandatory> *************** *** 237,243 **** <name>include-imports</name> <usage-description> ! When you include methods and fields, you mostly need imports as well. Like 'include-body', you specify a relative path to the file which contains your imports-statements. ! It is recommended to name the include file 'MyObjectIDClass.imports.inc'. </usage-description> <mandatory>false</mandatory> --- 250,256 ---- <name>include-imports</name> <usage-description> ! When you include methods and fields, you mostly need imports as well. Like 'include-body', you specify a relative path to the file which contains your imports-statements. ! It is recommended to name the include file 'MyObjectIDClass.imports.inc'. </usage-description> <mandatory>false</mandatory> *************** *** 325,331 **** It defines the strategy for datastore identity generation. Possible values according to the JDO standard are: ! 'native', 'sequence', 'autoassign', 'increment', 'identity' ! 'uuid-string', 'uuid-hex' ! JPOX-extensions: 'auid', 'max', 'custom' </usage-description> <mandatory>false</mandatory> --- 338,344 ---- It defines the strategy for datastore identity generation. Possible values according to the JDO standard are: ! 'native', 'sequence', 'autoassign', 'increment', 'identity' ! 'uuid-string', 'uuid-hex' ! JPOX-extensions: 'auid', 'max', 'custom' </usage-description> <mandatory>false</mandatory> *************** *** 729,733 **** <usage-description> Defines a fetch-group to be used by JDO detach. ! Example: @jdo.fetch-group name="fetch-some-fields" field-names="field0 [3], field1, field2" </usage-description> <unique>false</unique> --- 742,746 ---- <usage-description> Defines a fetch-group to be used by JDO detach. ! Example: '@jdo.fetch-group name="fetch-some-fields" fields="field0 [3], field1, field2" fetch-groups="other-group0, other-group1"' </usage-description> <unique>false</unique> *************** *** 755,762 **** <name>field-names</name> <usage-description> A comma-separated list of the fields that should be contained by this fetch-group. This list may contain spaces for better readability - they are ignored. Optionally, you can add the fetch-depth in square brackets after each field. ! Example: field-names="name, father [2], mother [2], children [5]" </usage-description> <mandatory>false</mandatory> --- 768,783 ---- <name>field-names</name> <usage-description> + This attribute is DEPRECATED! Use 'fields' instead! + </usage-description> + <mandatory>false</mandatory> + </parameter> + + <parameter type="text"> + <name>fields</name> + <usage-description> A comma-separated list of the fields that should be contained by this fetch-group. This list may contain spaces for better readability - they are ignored. Optionally, you can add the fetch-depth in square brackets after each field. ! Example: fields="name, father [2], mother [2], children [5]" </usage-description> <mandatory>false</mandatory> *************** *** 766,769 **** --- 787,798 ---- <name>fetch-group-names</name> <usage-description> + This attribute is DEPRECATED! Use 'fetch-groups' instead! + </usage-description> + <mandatory>false</mandatory> + </parameter> + + <parameter type="text"> + <name>fetch-groups</name> + <usage-description> A comma-separated list of previously defined fetch-groups to be included in this fetch-group. This avoids rewriting all the fields by just refering *************** *** 796,800 **** <name>language</name> <usage-description> ! Defines the query language. Possible values are 'javax.jdo.query.JDOQL', 'javax.jdo.query.SQL' or 'javax.jdo.query.JPOXSQL' (a vendor extension of the JPOX project). Other languages may be supported by your JDO implementation, but only the first two are guaranteed to be supported by all --- 825,829 ---- <name>language</name> <usage-description> ! Defines the query language. Possible values are 'javax.jdo.query.JDOQL', 'javax.jdo.query.SQL' or 'javax.jdo.query.JPOXSQL' (a vendor extension of the JPOX project). Other languages may be supported by your JDO implementation, but only the first two are guaranteed to be supported by all *************** *** 807,811 **** <name>query</name> <usage-description> ! The query expression itself, e.g. "SELECT FROM org.jpox.example.Product WHERE status == 'Sold Out'" </usage-description> <mandatory>true</mandatory> --- 836,840 ---- <name>query</name> <usage-description> ! The query expression itself, e.g. "SELECT FROM org.jpox.example.Product WHERE status == 'Sold Out'" </usage-description> <mandatory>true</mandatory> *************** *** 931,935 **** This parameter can only be used in JDO 2.0! It defines the name of the column into which this field should be ! persisted. You can use '@jdo.column name="xxx"' alternatively. </usage-description> <mandatory>false</mandatory> --- 960,964 ---- This parameter can only be used in JDO 2.0! It defines the name of the column into which this field should be ! persisted. You can use '@jdo.column name="xxx"' alternatively. </usage-description> <mandatory>false</mandatory> *************** *** 968,972 **** <usage-description> Specifies whether this field is managed as a group with other fields. ! It defaults to "true" for non-key fields of primitive types, java.util.Date, and fields of java.lang, java.math types specified above. </usage-description> --- 997,1001 ---- <usage-description> Specifies whether this field is managed as a group with other fields. ! It defaults to "true" for non-key fields of primitive types, java.util.Date, and fields of java.lang, java.math types specified above. </usage-description> *************** *** 979,983 **** Specifies whether the field should be stored if possible as part of the instance instead of as its own instance in the datastore. It defaults ! to "true" for fields of primitive types, java.util.Date, and fields of java.lang, java.math, and array types specified above. This attribute is only a hint to the implementation. A compliant implementation --- 1008,1012 ---- Specifies whether the field should be stored if possible as part of the instance instead of as its own instance in the datastore. It defaults ! to "true" for fields of primitive types, java.util.Date, and fields of java.lang, java.math, and array types specified above. This attribute is only a hint to the implementation. A compliant implementation *************** *** 1004,1008 **** It controls whether to delete the object in this field if the container object is deleted out of the store. Some people ! call this behaviour 'cascaded delete'. </usage-description> <mandatory>false</mandatory> --- 1033,1037 ---- It controls whether to delete the object in this field if the container object is deleted out of the store. Some people ! call this behaviour 'cascaded delete'. </usage-description> <mandatory>false</mandatory> *************** *** 1018,1024 **** values for one of the primary key fields. Possible values according to the JDO standard are: ! 'native', 'sequence', 'autoassign', 'increment', 'identity' ! 'uuid-string', 'uuid-hex' ! JPOX-extensions: 'auid', 'max', 'custom' </usage-description> <mandatory>false</mandatory> --- 1047,1053 ---- values for one of the primary key fields. Possible values according to the JDO standard are: ! 'native', 'sequence', 'autoassign', 'increment', 'identity' ! 'uuid-string', 'uuid-hex' ! JPOX-extensions: 'auid', 'max', 'custom' </usage-description> <mandatory>false</mandatory> *************** *** 1046,1050 **** <usage-description> This parameter can only be used in JDO 2.0! Possible values are: ! 'restrict', 'cascade', 'null', 'default', 'none' </usage-description> <mandatory>false</mandatory> --- 1075,1079 ---- <usage-description> This parameter can only be used in JDO 2.0! Possible values are: ! 'restrict', 'cascade', 'null', 'default', 'none' </usage-description> <mandatory>false</mandatory> *************** *** 1056,1060 **** <usage-description> This parameter can only be used in JDO 2.0! Possible values are: ! 'true', 'false', 'unique' </usage-description> <mandatory>false</mandatory> --- 1085,1089 ---- <usage-description> This parameter can only be used in JDO 2.0! Possible values are: ! 'true', 'false', 'unique' </usage-description> <mandatory>false</mandatory> *************** *** 1109,1113 **** Example: Person.addresses is a collection having instances of type Address. Address.person is the member that makes Address know to which person it belongs. ! Thus, in the declaration of Person.addresses, mapped-by="person" must be specified. </usage-description> <mandatory>false</mandatory> --- 1138,1142 ---- Example: Person.addresses is a collection having instances of type Address. Address.person is the member that makes Address know to which person it belongs. ! Thus, in the declaration of Person.addresses, mapped-by="person" must be specified. </usage-description> <mandatory>false</mandatory> *************** *** 1248,1256 **** <usage-description> You can specify jdo-implementation-specific extensions using this tag, if ! you declared '@jdo.field collection-type="collection"'. </usage-description> <unique>false</unique> <condition-description> ! Applicable only if the collection-type is "collection". </condition-description> <condition type="field" /> --- 1277,1285 ---- <usage-description> You can specify jdo-implementation-specific extensions using this tag, if ! you declared '@jdo.field collection-type="collection"'. </usage-description> <unique>false</unique> <condition-description> ! Applicable only if the collection-type is "collection". </condition-description> <condition type="field" /> *************** *** 1295,1303 **** <usage-description> You can specify jdo-implementation-specific extensions using this tag, if ! you declared '@jdo.field collection-type="map"'. </usage-description> <unique>false</unique> <condition-description> ! Applicable only if the collection-type is "map". </condition-description> <condition type="field" /> --- 1324,1332 ---- <usage-description> You can specify jdo-implementation-specific extensions using this tag, if ! you declared '@jdo.field collection-type="map"'. </usage-description> <unique>false</unique> <condition-description> ! Applicable only if the collection-type is "map". </condition-description> <condition type="field" /> *************** *** 1342,1350 **** <usage-description> You can specify jdo-implementation-specific extensions using this tag, if ! you declared '@jdo.field collection-type="array"'. </usage-description> <unique>false</unique> <condition-description> ! Applicable only if the collection-type is "array". </condition-description> <condition type="field" /> --- 1371,1379 ---- <usage-description> You can specify jdo-implementation-specific extensions using this tag, if ! you declared '@jdo.field collection-type="array"'. </usage-description> <unique>false</unique> <condition-description> ! Applicable only if the collection-type is "array". </condition-description> <condition type="field" /> *************** *** 1390,1398 **** The jdo.join tag is only available in JDO 2.0! When defining a collection (or a map), there are two possibilities: Either the ! linked object knows its owner (this is called "inverse relationship") or ! not (which is called "normal relationship"). If using an inverse relationship, ! you don't use jdo.join but set the property mapped-by of the tag jdo.field. For a normal relationship, jdo.join defines parameters of how the owner ! shall be linked to its collection/map elements. Often, a simple '@jdo.join' without parameters is sufficient. </usage-description> --- 1419,1427 ---- The jdo.join tag is only available in JDO 2.0! When defining a collection (or a map), there are two possibilities: Either the ! linked object knows its owner (this is called "inverse relationship") or ! not (which is called "normal relationship"). If using an inverse relationship, ! you don't use jdo.join but set the property mapped-by of the tag jdo.field. For a normal relationship, jdo.join defines parameters of how the owner ! shall be linked to its collection/map elements. Often, a simple '@jdo.join' without parameters is sufficient. </usage-description> *************** *** 1482,1486 **** It is used to specify information for each column used in a normal relationship in a Collection/Map. ! Important: This requires the tag '@jdo.join' to be present, too! </usage-description> <unique>false</unique> --- 1511,1515 ---- It is used to specify information for each column used in a normal relationship in a Collection/Map. ! Important: This requires the tag '@jdo.join' to be present, too! </usage-description> <unique>false</unique> *************** *** 1724,1728 **** of the Collection (in case they are no FCOs). To define the column-settings for a Map, use @jdo.key-column or @jdo.value-column (with the same parameters). ! Note, that '@jdo.element' is NOT necessary anymore for '@jdo.element-column' to work. </usage-description> <unique>true</unique> --- 1753,1757 ---- of the Collection (in case they are no FCOs). To define the column-settings for a Map, use @jdo.key-column or @jdo.value-column (with the same parameters). ! Note, that '@jdo.element' is NOT necessary anymore for '@jdo.element-column' to work. </usage-description> <unique>true</unique> *************** *** 1838,1846 **** <usage-description> You can specify jdo-implementation-specific extensions using this tag. ! Important: This requires '@jdo.element-column' to be present! </usage-description> <unique>false</unique> <condition-description> ! Applicable only if '@jdo.element-column' is declared, too. </condition-description> <condition type="field" /> --- 1867,1875 ---- <usage-description> You can specify jdo-implementation-specific extensions using this tag. ! Important: This requires '@jdo.element-column' to be present! </usage-description> <unique>false</unique> <condition-description> ! Applicable only if '@jdo.element-column' is declared, too. </condition-description> <condition type="field" /> *************** *** 1885,1889 **** <usage-description> This is only supported by JDO 2.0 and only applicable to a Map field. You ! may use it to declare properties of the Map's key field. </usage-description> <unique>true</unique> --- 1914,1918 ---- <usage-description> This is only supported by JDO 2.0 and only applicable to a Map field. You ! may use it to declare properties of the Map's key field. </usage-description> <unique>true</unique> *************** *** 1953,1957 **** <name>mapped-by</name> <usage-description> ! If the Map's key object is a member of its corresponding value object, this specifies the name of the java field. </usage-description> --- 1982,1986 ---- <name>mapped-by</name> <usage-description> ! If the Map's key object is a member of its corresponding value object, this specifies the name of the java field. </usage-description> *************** *** 1970,1977 **** allows to declare which jdbc/sql data type shall be used, which length and various other column-specific settings. It is applied to the key ! of the Map. To define the column-settings for the Map's value, use @jdo.value-column (with the same parameters). For Collection fields, use @jdo.element-column. ! Note, that '@jdo.key-column' does NOT anymore require '@jdo.key' to be present. </usage-description> <unique>false</unique> --- 1999,2006 ---- allows to declare which jdbc/sql data type shall be used, which length and various other column-specific settings. It is applied to the key ! of the Map. To define the column-settings for the Map's value, use @jdo.value-column (with the same parameters). For Collection fields, use @jdo.element-column. ! Note, that '@jdo.key-column' does NOT anymore require '@jdo.key' to be present. </usage-description> <unique>false</unique> *************** *** 2087,2091 **** <usage-description> This is only supported by JDO 2.0 and only applicable to a Map field. You ! may use it to declare properties of the Map's value field. </usage-description> <unique>true</unique> --- 2116,2120 ---- <usage-description> This is only supported by JDO 2.0 and only applicable to a Map field. You ! may use it to declare properties of the Map's value field. </usage-description> <unique>true</unique> *************** *** 2155,2159 **** <name>mapped-by</name> <usage-description> ! If the Map's value object is a member of its corresponding value object, this specifies the name of the java field. </usage-description> --- 2184,2188 ---- <name>mapped-by</name> <usage-description> ! If the Map's value object is a member of its corresponding value object, this specifies the name of the java field. </usage-description> *************** *** 2172,2179 **** allows to declare which jdbc/sql data type shall be used, which length and various other column-specific settings. It is applied to the value ! of the Map. To define the column-settings for the Map's key, use ! '@jdo.key-column' (with the same parameters). For Collection fields, use ! '@jdo.element-column'. ! Note, that '@jdo.value' is not necessary for '@jdo.value-column' to take effect. </usage-description> <unique>false</unique> --- 2201,2208 ---- allows to declare which jdbc/sql data type shall be used, which length and various other column-specific settings. It is applied to the value ! of the Map. To define the column-settings for the Map's key, use ! '@jdo.key-column' (with the same parameters). For Collection fields, use ! '@jdo.element-column'. ! Note, that '@jdo.value' is not necessary for '@jdo.value-column' to take effect. </usage-description> <unique>false</unique> *************** *** 2460,2464 **** <usage-description> The style of the mapping between this class and the objects contained in the collection. ! For 1:n relationships, the style is 'foreign-key'. For n:m relationships, the style is 'relation-table' </usage-description> <mandatory>true</mandatory> --- 2489,2493 ---- <usage-description> The style of the mapping between this class and the objects contained in the collection. ! For 1:n relationships, the style is 'foreign-key'. For n:m relationships, the style is 'relation-table' </usage-description> <mandatory>true</mandatory> *************** *** 2478,2482 **** <name>table-name</name> <usage-description> ! Name of the relation table when style is 'relation-table' </usage-description> <mandatory>false</mandatory> --- 2507,2511 ---- <name>table-name</name> <usage-description> ! Name of the relation table when style is 'relation-table' </usage-description> <mandatory>false</mandatory> ------------------------------------------------------- SF.Net email is sponsored by: Tame your development challenges with Apache's Geronimo App Server. Download it for free - -and be entered to win a 42" plasma tv or your very own Sony(tm)PSP. Click here to play: http://sourceforge.net/geronimo.php _______________________________________________ xdoclet-devel mailing list xdoclet-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/xdoclet-devel