Author: arminw
Date: Wed Nov 7 16:48:47 2007
New Revision: 592984
URL: http://svn.apache.org/viewvc?rev=592984&view=rev
Log:
rename and update doclipse support file
Added:
db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml (contents,
props changed)
- copied, changed from r589928,
db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb.xml
Removed:
db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb.xml
Copied: db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml (from
r589928, db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb.xml)
URL:
http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml?p2=db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml&p1=db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb.xml&r1=589928&r2=592984&rev=592984&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml Wed Nov 7
16:48:47 2007
@@ -55,15 +55,6 @@
<attribute name="isolation-level"
allowed="read-uncommitted read-committed repeatable-read
serializable optimistic none"
doc="For ODMG: the transactional isolation level; default
is 'read-uncommitted'"/>
- <attribute name="state-detection"
- allowed="on off inherit"
- doc="The state-detection attribute is used by API's
supporting automatic state detection of
- persistence capable objects (automatic detection of changed
object fields - e.g. like
- the ODMG implementation). The attribute indicate whether or
not the object state detection
- is enabled for this class or if it's inherited from a
higher level entity."/>
- <attribute name="field-class"
- doc="The field-class attribute can be used to override the
PersistentField implementation class.
- OJB's shortcut name feature is supported."/>
<attribute name="proxy"
doc="Determines whether proxies are used for instances of
this class; can be 'dynamic' for automatic dynamic proxies, or the fully
qualified class name of the proxy class to use"/>
<attribute name="proxy-prefetching-limit"
@@ -73,10 +64,32 @@
doc="Forces OJB to refresh instances of this type when
loaded from the cache; default value is 'false'"/>
<attribute name="row-reader"
doc="Gives the fully qualified name of the class that reads
instances of this class from the database"/>
+ <attribute name="schema"
+ doc="Contains the database schema owning the table mapped
to this class"/>
<attribute name="table"
doc="The database table onto which this class is mapped"/>
+ <attribute name="field-class"
+ doc="The field-class attribute can be used to override the
PersistentField implementation class.
+ OJB's shortcut name feature is supported."/>
+ <attribute name="state-detection"
+ allowed="on off inherit"
+ doc="The state-detection attribute is used by API's
supporting automatic state detection of
+ persistence capable objects (automatic detection of changed
object fields - e.g. like
+ the ODMG implementation). The attribute indicate whether or
not the object state detection
+ is enabled for this class or if it's inherited from a
higher level entity."/>
</tag>
+ <tag name="@ojb.object-cache"
+ target="class"
+ doc="Specifies which object cache implementation shall be used for
this class">
+ <attribute name="attributes"
+ doc="Contains attributes for the object cache instance as
name-value pairs of the form 'name1=value1,name2=value2'"/>
+ <attribute name="class"
+ required="true"
+ doc="Specifies the fully qualified name of the object cache
implementation class. OJB's shortcut name feature is supported"/>
+ <attribute name="documentation"
+ doc="Documentation for the object cache"/>
+ </tag>
<tag name="@ojb.extent-class"
target="class"
@@ -85,7 +98,6 @@
doc="The fully qualified name of the subclass"/>
</tag>
-
<tag name="@ojb.modify-inherited"
target="class"
doc="Use this tag to modify attributes of inherited
fields/references/collections">
@@ -94,18 +106,18 @@
doc="For fields: modifies the 'access' attribute of the
inherited feature"/>
<attribute name="attributes"
doc="For fields, references, collections: modifies the
'attributes' attribute of the inherited feature"/>
+ <attribute name="autoincrement"
+ allowed="none ojb database"
+ doc="For fields: modifies the 'autoincrement' attribute of
the inherited feature"/>
<attribute name="auto-delete"
- allowed="true false none link object"
+ allowed="none link object true false"
doc="For references, collections: modifies the
'auto-delete' attribute of the inherited feature"/>
<attribute name="auto-retrieve"
allowed="true false"
doc="For references, collections: modifies the
'auto-retrieve' attribute of the inherited feature"/>
<attribute name="auto-update"
- allowed="true false none link object"
+ allowed="true false none link create object"
doc="For references, collections: modifies the
'auto-update' attribute of the inherited feature"/>
- <attribute name="autoincrement"
- allowed="none ojb database"
- doc="For fields: modifies the 'autoincrement' attribute of
the inherited feature"/>
<attribute name="class-ref"
doc="For references: modifies the 'class-ref' attribute of
the inherited feature"/>
<attribute name="collection-class"
@@ -126,13 +138,11 @@
doc="For references, collections: modifies the 'foreignkey'
attribute of the inherited feature"/>
<attribute name="id"
doc="For fields: modifies the 'id' attribute of the
inherited feature"/>
- <attribute name="ignore"
- allowed="true false"
- doc="If set to 'true', then the feature will not be
included in the class descriptor for the current class. Default value is
'false'"/>
<attribute name="indexed"
allowed="true false"
doc="For fields: modifies the 'indexed' attribute of the
inherited feature"/>
<attribute name="jdbc-type"
+ allowed="BIT BOOLEAN TINYINT SMALLINT INTEGER BIGINT DOUBLE
FLOAT REAL NUMERIC DECIMAL CHAR VARCHAR LONGVARCHAR DATE TIME TIMESTAMP BINARY
VARBINARY LONGVARBINARY CLOB BLOB STRUCT ARRAY REF DATALINK JAVA_OBJECT"
doc="For fields: modifies the 'jdbc-type' attribute of the
inherited feature"/>
<attribute name="length"
doc="For fields: modifies the 'length' attribute of the
inherited feature"/>
@@ -149,7 +159,7 @@
doc="For collection: modifies the 'orderby' attribute of
the inherited feature"/>
<attribute name="otm-dependent"
allowed="true false"
- doc="For references, collections: modifies the
'otm-dependent' attribute of the inherited feature"/>
+ doc="DEPRECATED! For references, collections: modifies the
'otm-dependent' attribute of the inherited feature"/>
<attribute name="precision"
doc="For fields: modifies the 'precision' attribute of the
inherited feature"/>
<attribute name="primarykey"
@@ -160,10 +170,6 @@
doc="For references, collections: modifies the 'proxy'
attribute of the inherited feature"/>
<attribute name="proxy-prefetching-limit"
doc="For references, collections: modifies the
'proxy-prefetching-limit' attribute of the inherited feature"/>
- <attribute name="query-customizer"
- doc="For collections: modifies the 'query-customizer'
attribute of the inherited feature"/>
- <attribute name="query-customizer-attributes"
- doc="For collections: modifies the
'query-customizer-attributes' attribute of the inherited feature"/>
<attribute name="refresh"
allowed="true false"
doc="For references, collections: modifies the 'refresh'
attribute of the inherited feature"/>
@@ -171,6 +177,8 @@
doc="For fields: modifies the 'scale' attribute of the
inherited feature"/>
<attribute name="sequence-name"
doc="For fields: modifies the 'sequence-name' attribute of
the inherited feature"/>
+ <attribute name="table"
+ doc="Overrides the table attribute of the field tag"/>
<attribute name="update-lock"
allowed="true false"
doc="For fields: modifies the 'update-lock' attribute of
the inherited feature"/>
@@ -186,18 +194,15 @@
<attribute name="field-class"
doc="The field-class attribute can be used to override the
PersistentField implementation class.
OJB's shortcut name feature is supported."/>
+ <attribute name="query-customizer"
+ doc="For collections: modifies the 'query-customizer'
attribute of the inherited feature"/>
+ <attribute name="query-customizer-attributes"
+ doc="For collections: modifies the
'query-customizer-attributes' attribute of the inherited feature"/>
+ <attribute name="ignore"
+ allowed="true false"
+ doc="If set to 'true', then the feature will not be
included in the class descriptor for the current class. Default value is
'false'"/>
</tag>
- <tag name="@ojb.object-cache"
- target="class"
- doc="Specifies which object cache implementation shall be used for
this class">
- <attribute name="attributes"
- doc="Contains attributes for the object cache instance as
name-value pairs of the form 'name1=value1,name2=value2'"/>
- <attribute name="class"
- required="true"
- doc="Specifies the fully qualified name of the object cache
implementation class"/>
- <attribute name="documentation"
- doc="Documentation for the object cache"/>
- </tag>
+
<tag name="@ojb.index"
target="class"
doc="Defines an index for this class">
@@ -213,89 +218,7 @@
allowed="true false"
doc="Whether this is a unique index; default value is
'false'"/>
</tag>
- <tag name="@ojb.delete-procedure"
- target="class"
- doc="Specifies a procedure/function that handles deletion of objects
in the database">
- <attribute name="arguments"
- doc="A comma-separated list of names that identify the
constant-argument and/or runtime-argument tags at this class which belong to
this delete procedure"/>
- <attribute name="attributes"
- doc="Contains attributes for the delete procedure as
name-value pairs of the form 'name1=value1,name2=value2'"/>
- <attribute name="documentation"
- doc="Documentation for the delete procedure"/>
- <attribute name="include-pk-only"
- allowed="true false"
- doc="If set to 'true', then all persistent fields of this
class marked as primareykeys will be passed to the delete procedure, and the
arguments attribute will be ignored; default value is 'false'"/>
- <attribute name="name"
- required="true"
- doc="The name of the delete procedure"/>
- <attribute name="return-field-ref"
- doc="Specifies the field that will receive the return value
of this delete procedure"/>
- </tag>
- <tag name="@ojb.insert-procedure"
- target="class"
- doc="">
- <attribute name="arguments"
- doc="A comma-separated list of names that identify the
constant-argument and/or runtime-argument tags at this class which belong to
this insert procedure"/>
- <attribute name="attributes"
- doc="Contains attributes for the insert procedure as
name-value pairs of the form 'name1=value1,name2=value2'"/>
- <attribute name="documentation"
- doc="Documentation for the insert procedure"/>
- <attribute name="include-all-fields"
- allowed="true false"
- doc="If set to 'true', then all persistent fields of this
class will be passed to the insert procedure, and the arguments attribute will
be ignored; default value is 'false'"/>
- <attribute name="name"
- required="true"
- doc="The name of the insert procedure"/>
- <attribute name="return-field-ref"
- doc="Specifies the field that will receive the return value
of this insert procedure"/>
- </tag>
- <tag name="@ojb.update-procedure"
- target="class"
- doc="">
- <attribute name="arguments"
- doc="A comma-separated list of names that identify the
constant-argument and/or runtime-argument tags at this class which belong to
this procedure"/>
- <attribute name="attributes"
- doc="Contains attributes for the update procedure as
name-value pairs of the form 'name1=value1,name2=value2'"/>
- <attribute name="documentation"
- doc="Documentation for the update procedure"/>
- <attribute name="include-all-fields"
- allowed="true false"
- doc="If set to 'true', then all persistent fields of this
class will be passed to the update procedure, and the arguments attribute will
be ignored; default value is 'false'"/>
- <attribute name="name"
- required="true"
- doc="The name of the update procedure"/>
- <attribute name="return-field-ref"
- doc="Specifies the field that will receive the return value
of this update procedure"/>
- </tag>
- <tag name="@ojb.constant-argument"
- target="class"
- doc="Defines a constant argument to be used by a delete, insert or
update procedure">
- <attribute name="attributes"
- doc="Contains attributes of the argument as name-value
pairs of the form 'name1=value1,name2=value2'"/>
- <attribute name="documentation"
- doc="Documentation for the argument"/>
- <attribute name="value"
- doc="The constant value"/>
- <attribute name="name"
- required="true"
- doc="The name of the argument"/>
- </tag>
- <tag name="@ojb.runtime-argument"
- target="class"
- doc="Defines a runtime argument to be used by a delete, insert or
update procedure">
- <attribute name="attributes"
- doc="Contains attributes of the argument as name-value
pairs of the form 'name1=value1,name2=value2'"/>
- <attribute name="documentation"
- doc="Documentation for the argument"/>
- <attribute name="field-ref"
- doc="Specifies the field whose value is passed to the
procedure; if not specified, then 'null' is used as tje value"/>
- <attribute name="name"
- required="true"
- doc="The name of the argument"/>
- <attribute name="return"
- allowed="true false"
- doc="Whether this is a return value rather than a parameter
to the procedure"/>
- </tag>
+
<tag name="@ojb.field"
target="class method field"
doc="Declares a persistent field">
@@ -322,6 +245,7 @@
allowed="true false"
doc="Specifies whether there is an index on this field (the
default index). Default value is 'false'"/>
<attribute name="jdbc-type"
+ allowed="BIT BOOLEAN TINYINT SMALLINT INTEGER BIGINT DOUBLE
FLOAT REAL NUMERIC DECIMAL CHAR VARCHAR LONGVARCHAR DATE TIME TIMESTAMP BINARY
VARBINARY LONGVARBINARY CLOB BLOB STRUCT ARRAY REF DATALINK JAVA_OBJECT"
doc="The jdbc type of the column corresponding to this
field"/>
<attribute name="length"
doc="Gives the length setting if the jdbc type of the
column requires it"/>
@@ -361,13 +285,13 @@
<attribute name="attributes"
doc="Contains attributes of the reference as name-value
pairs of the form 'name1=value1,name2=value2'"/>
<attribute name="auto-delete"
- allowed="true false none link object"
+ allowed="none link object true false"
doc="Specifies what OJB should do with the referenced
object when deleting an instance of this class from the database; default value
is 'false'"/>
<attribute name="auto-retrieve"
allowed="true false"
doc="Specifies whether OJB should also load the referenced
object when loading an instance of this class from the database; default value
is 'true'"/>
<attribute name="auto-update"
- allowed="true false none link object"
+ allowed="none link create object true false"
doc="Specifies what OJB should do with the referenced
object when udpating an instance of this class in the database; default value
is 'false'"/>
<attribute name="class-ref"
doc="The fully qualified name of the referenced class.
Should only be necessary when if the declared class is different from actual
referenced class"/>
@@ -394,16 +318,16 @@
<attribute name="attributes"
doc="Contains attributes of the collection as name-value
pairs of the form 'name1=value1,name2=value2'"/>
<attribute name="auto-delete"
- allowed="true false none link object"
+ allowed="none link object true false"
doc="Specifies what OJB should do with the collection
elements when deleting an instance of this class from the database; default
value is 'false'"/>
<attribute name="auto-retrieve"
allowed="true false"
doc="Specifies whether OJB should also load the elements of
the collection when loading an instance of this class from the database;
default value is 'true'"/>
<attribute name="auto-update"
- allowed="true false none link object"
+ allowed="none link create object true false"
doc="Specifies what OJB should do with the collection
elements when updating an instance of this class in the database; default value
is 'false'"/>
<attribute name="collection-class"
- doc="Gives the fully qualified name of the class that
realizes the collection"/>
+ doc="Gives the fully qualified name of the class that
realizes the collection. OJB's shortcut name feature is supported."/>
<attribute name="documentation"
doc="Documentation for the collection"/>
<attribute name="element-class-ref"
@@ -445,13 +369,13 @@
<attribute name="attributes"
doc="For fields, references, collections: modifies the
'attributes' attribute of the nested feature"/>
<attribute name="auto-delete"
- allowed="true false none link object"
+ allowed="none link object true false"
doc="For references, collections: modifies the
'auto-delete' attribute of the nested feature"/>
<attribute name="auto-retrieve"
allowed="true false"
doc="For references, collections: modifies the
'auto-retrieve' attribute of the nested feature"/>
<attribute name="auto-update"
- allowed="true false none link object"
+ allowed="none link create object true false"
doc="For references, collections: modifies the
'auto-update' attribute of the nested feature"/>
<attribute name="autoincrement"
allowed="none ojb database"
@@ -476,13 +400,11 @@
doc="For references, collections: modifies the 'foreignkey'
attribute of the nested feature"/>
<attribute name="id"
doc="For fields: modifies the 'id' attribute of the nested
feature"/>
- <attribute name="ignore"
- allowed="true false"
- doc="If set to 'true', then the feature will not be
included in the class descriptor for the current class. Default value is
'false'"/>
<attribute name="indexed"
allowed="true false"
doc="For fields: modifies the 'indexed' attribute of the
nested feature"/>
<attribute name="jdbc-type"
+ allowed="BIT BOOLEAN TINYINT SMALLINT INTEGER BIGINT DOUBLE
FLOAT REAL NUMERIC DECIMAL CHAR VARCHAR LONGVARCHAR DATE TIME TIMESTAMP BINARY
VARBINARY LONGVARBINARY CLOB BLOB STRUCT ARRAY REF DATALINK JAVA_OBJECT"
doc="For fields: modifies the 'jdbc-type' attribute of the
nested feature"/>
<attribute name="length"
doc="For fields: modifies the 'length' attribute of the
nested feature"/>
@@ -535,5 +457,96 @@
doc="For fields: modifies the 'field-class' attribute of
the nested feature.
The field-class attribute can be used to override the
PersistentField implementation class.
OJB's shortcut name feature is supported."/>
+ <attribute name="ignore"
+ allowed="true false"
+ doc="If set to 'true', then the feature will not be
included in the class descriptor for the current class. Default value is
'false'"/>
+ </tag>
+
+ <tag name="@ojb.delete-procedure"
+ target="class"
+ doc="Specifies a procedure/function that handles deletion of objects
in the database">
+ <attribute name="arguments"
+ doc="A comma-separated list of names that identify the
constant-argument and/or runtime-argument tags at this class which belong to
this delete procedure"/>
+ <attribute name="attributes"
+ doc="Contains attributes for the delete procedure as
name-value pairs of the form 'name1=value1,name2=value2'"/>
+ <attribute name="documentation"
+ doc="Documentation for the delete procedure"/>
+ <attribute name="include-pk-only"
+ allowed="true false"
+ doc="If set to 'true', then all persistent fields of this
class marked as primareykeys will be passed to the delete procedure, and the
arguments attribute will be ignored; default value is 'false'"/>
+ <attribute name="name"
+ required="true"
+ doc="The name of the delete procedure"/>
+ <attribute name="return-field-ref"
+ doc="Specifies the field that will receive the return value
of this delete procedure"/>
+ </tag>
+
+ <tag name="@ojb.insert-procedure"
+ target="class"
+ doc="">
+ <attribute name="arguments"
+ doc="A comma-separated list of names that identify the
constant-argument and/or runtime-argument tags at this class which belong to
this insert procedure"/>
+ <attribute name="attributes"
+ doc="Contains attributes for the insert procedure as
name-value pairs of the form 'name1=value1,name2=value2'"/>
+ <attribute name="documentation"
+ doc="Documentation for the insert procedure"/>
+ <attribute name="include-all-fields"
+ allowed="true false"
+ doc="If set to 'true', then all persistent fields of this
class will be passed to the insert procedure, and the arguments attribute will
be ignored; default value is 'false'"/>
+ <attribute name="name"
+ required="true"
+ doc="The name of the insert procedure"/>
+ <attribute name="return-field-ref"
+ doc="Specifies the field that will receive the return value
of this insert procedure"/>
+ </tag>
+
+ <tag name="@ojb.update-procedure"
+ target="class"
+ doc="">
+ <attribute name="arguments"
+ doc="A comma-separated list of names that identify the
constant-argument and/or runtime-argument tags at this class which belong to
this procedure"/>
+ <attribute name="attributes"
+ doc="Contains attributes for the update procedure as
name-value pairs of the form 'name1=value1,name2=value2'"/>
+ <attribute name="documentation"
+ doc="Documentation for the update procedure"/>
+ <attribute name="include-all-fields"
+ allowed="true false"
+ doc="If set to 'true', then all persistent fields of this
class will be passed to the update procedure, and the arguments attribute will
be ignored; default value is 'false'"/>
+ <attribute name="name"
+ required="true"
+ doc="The name of the update procedure"/>
+ <attribute name="return-field-ref"
+ doc="Specifies the field that will receive the return value
of this update procedure"/>
+ </tag>
+
+ <tag name="@ojb.constant-argument"
+ target="class"
+ doc="Defines a constant argument to be used by a delete, insert or
update procedure">
+ <attribute name="attributes"
+ doc="Contains attributes of the argument as name-value
pairs of the form 'name1=value1,name2=value2'"/>
+ <attribute name="documentation"
+ doc="Documentation for the argument"/>
+ <attribute name="value"
+ doc="The constant value"/>
+ <attribute name="name"
+ required="true"
+ doc="The name of the argument"/>
+ </tag>
+
+ <tag name="@ojb.runtime-argument"
+ target="class"
+ doc="Defines a runtime argument to be used by a delete, insert or
update procedure">
+ <attribute name="attributes"
+ doc="Contains attributes of the argument as name-value
pairs of the form 'name1=value1,name2=value2'"/>
+ <attribute name="documentation"
+ doc="Documentation for the argument"/>
+ <attribute name="field-ref"
+ doc="Specifies the field whose value is passed to the
procedure; if not specified, then 'null' is used as tje value"/>
+ <attribute name="name"
+ required="true"
+ doc="The name of the argument"/>
+ <attribute name="return"
+ allowed="true false"
+ doc="Whether this is a return value rather than a parameter
to the procedure"/>
</tag>
</doclipse>
Propchange: db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: db/ojb/branches/OJB_1_0_RELEASE/src/xdoclet/ojb-doclipse.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
