db-ojb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From to...@apache.org
Subject cvs commit: db-ojb/src/xdoclet ojb.xml
Date Thu, 24 Jun 2004 22:33:34 GMT
tomdz       2004/06/24 15:33:34

  Modified:    src/xdoclet ojb.xml
  Log:
  Added documentation of the tags and attributes
  
  Revision  Changes    Path
  1.2       +459 -194  db-ojb/src/xdoclet/ojb.xml
  
  Index: ojb.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/xdoclet/ojb.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ojb.xml	23 Jun 2004 22:05:30 -0000	1.1
  +++ ojb.xml	24 Jun 2004 22:33:34 -0000	1.2
  @@ -1,204 +1,469 @@
   <?xml version="1.0" encoding="UTF-8"?>
   
  -<!-- This is the doclipse completion file for OJB -->
   <doclipse>
       <description>Tags for the OJB XDoclet module</description>
       <tag name="@ojb.class"
            target="class"
            doc="Declares that this class is persistent via OJB">
           <attribute name="accept-locks"
  -                   allowed="true false"/>
  -        <attribute name="attributes"/>
  -        <attribute name="determine-extents" allowed="true false"/>
  -        <attribute name="documentation"/>
  -        <attribute name="factory-class"/>
  -        <attribute name="factory-method"/>
  -        <attribute name="generate-table-info" allowed="true false"/>
  -        <attribute name="include-inherited" allowed="true false"/>
  -        <attribute name="initialization-method"/>
  -        <attribute name="isolation-level" allowed="read-uncommitted read-committed repeatable-read
serializable optimistic"/>
  -        <attribute name="proxy"/>
  -        <attribute name="proxy-prefetching-limit"/>
  -        <attribute name="refresh" allowed="true false"/>
  -        <attribute name="row-reader"/>
  -        <attribute name="table"/>
  -    </tag>
  -    <tag name="@ojb.extent-class" target="class">
  -        <attribute name="class-ref"/>
  -    </tag>
  -    <tag name="@ojb.modify-inherited" target="class">
  -        <attribute name="access" allowed="readonly readwrite"/>
  -        <attribute name="attributes"/>
  -        <attribute name="auto-delete" allowed="true false none link object"/>
  -        <attribute name="auto-retrieve" allowed="true false"/>
  -        <attribute name="auto-update" allowed="true false none link object"/>
  -        <attribute name="autoincrement" allowed="none ojb database"/>
  -        <attribute name="class-ref"/>
  -        <attribute name="collection-class"/>
  -        <attribute name="column"/>
  -        <attribute name="conversion"/>
  -        <attribute name="default-fetch" allowed="true false"/>
  -        <attribute name="documentation"/>
  -        <attribute name="element-class-ref"/>
  -        <attribute name="foreignkey" required="true"/>
  -        <attribute name="id"/>
  -        <attribute name="ignore" allowed="true false"/>
  -        <attribute name="indexed" allowed="true false"/>
  -        <attribute name="jdbc-type"/>
  -        <attribute name="length"/>
  -        <attribute name="locking" allowed="true false"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="nullable" allowed="true false"/>
  -        <attribute name="orderby"/>
  -        <attribute name="otm-dependent" allowed="true false"/>
  -        <attribute name="precision"/>
  -        <attribute name="primarykey" allowed="true false"/>
  -        <attribute name="proxy" allowed="true false"/>
  -        <attribute name="proxy-prefetching-limit"/>
  -        <attribute name="query-customizer"/>
  -        <attribute name="query-customizer-attributes"/>
  -        <attribute name="refresh" allowed="true false"/>
  -        <attribute name="scale"/>
  -        <attribute name="sequence-name"/>
  -        <attribute name="update-lock" allowed="true false"/>
  -    </tag>
  -    <tag name="@ojb.object-cache" target="class">
  -        <attribute name="attributes"/>
  -        <attribute name="class" required="true"/>
  -        <attribute name="documentation"/>
  -    </tag>
  -    <tag name="@ojb.index" target="class">
  -        <attribute name="documentation"/>
  -        <attribute name="fields" required="true"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="unique" allowed="true false"/>
  -    </tag>
  -    <tag name="@ojb.delete-procedure" target="class">
  -        <attribute name="arguments"/>
  -        <attribute name="attributes"/>
  -        <attribute name="documentation"/>
  -        <attribute name="include-pk-only" allowed="true false"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="return-field-ref"/>
  -    </tag>
  -    <tag name="@ojb.insert-procedure" target="class">
  -        <attribute name="arguments"/>
  -        <attribute name="attributes"/>
  -        <attribute name="documentation"/>
  -        <attribute name="include-all-fields" allowed="true false"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="return-field-ref"/>
  -    </tag>
  -    <tag name="@ojb.update-procedure" target="class">
  -        <attribute name="arguments"/>
  -        <attribute name="attributes"/>
  -        <attribute name="documentation"/>
  -        <attribute name="include-all-fields" allowed="true false"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="return-field-ref"/>
  -    </tag>
  -    <tag name="@ojb.constant-argument" target="class">
  -        <attribute name="attributes"/>
  -        <attribute name="documentation"/>
  -        <attribute name="value"/>
  -        <attribute name="name" required="true"/>
  -    </tag>
  -    <tag name="@ojb.runtime-procedure" target="class">
  -        <attribute name="attributes"/>
  -        <attribute name="documentation"/>
  -        <attribute name="field-ref"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="return" allowed="true false"/>
  -    </tag>
  -    <tag name="@ojb.field" target="class method field">
  -        <attribute name="access" allowed="readonly readwrite"/>
  -        <attribute name="attributes"/>
  -        <attribute name="autoincrement" allowed="none ojb database"/>
  -        <attribute name="column"/>
  -        <attribute name="conversion"/>
  -        <attribute name="default-fetch" allowed="true false"/>
  -        <attribute name="documentation"/>
  -        <attribute name="id"/>
  -        <attribute name="indexed" allowed="true false"/>
  -        <attribute name="jdbc-type"/>
  -        <attribute name="length"/>
  -        <attribute name="locking" allowed="true false"/>
  -        <attribute name="name"/>
  -        <attribute name="nullable" allowed="true false"/>
  -        <attribute name="precision"/>
  -        <attribute name="primarykey" allowed="true false"/>
  -        <attribute name="scale"/>
  -        <attribute name="sequence-name"/>
  -        <attribute name="update-lock" allowed="true false"  />
  -    </tag>
  -    <tag name="@ojb.reference" target="class method field">
  -        <attribute name="attributes"/>
  -        <attribute name="auto-delete" allowed="true false none link object"/>
  -        <attribute name="auto-retrieve" allowed="true false"/>
  -        <attribute name="auto-update" allowed="true false none link object"/>
  -        <attribute name="class-ref"/>
  -        <attribute name="documentation"/>
  -        <attribute name="foreignkey" required="true"/>
  -        <attribute name="otm-dependent" allowed="true false"/>
  -        <attribute name="proxy" allowed="true false"/>
  -        <attribute name="proxy-prefetching-limit"/>
  -        <attribute name="refresh" allowed="true false"/>
  -    </tag>
  -    <tag name="@ojb.collection" target="method field">
  -        <attribute name="attributes"/>
  -        <attribute name="auto-delete" allowed="true false none link object"/>
  -        <attribute name="auto-retrieve" allowed="true false"/>
  -        <attribute name="auto-update" allowed="true false none link object"/>
  -        <attribute name="collection-class"/>
  -        <attribute name="documentation"/>
  -        <attribute name="element-class-ref"/>
  -        <attribute name="foreignkey" required="true"/>
  -        <attribute name="indirection-table"/>
  -        <attribute name="orderby"/>
  -        <attribute name="otm-dependent" allowed="true false"/>
  -        <attribute name="proxy" allowed="true false"/>
  -        <attribute name="proxy-prefetching-limit"/>
  -        <attribute name="query-customizer"/>
  -        <attribute name="query-customizer-attributes"/>
  -        <attribute name="refresh" allowed="true false"/>
  -        <attribute name="remote-foreignkey"/>
  -    </tag>
  -    <tag name="@ojb.nested" target="method field">
  -    </tag>
  -    <tag name="@ojb.modify-nested" target="method field">
  -        <attribute name="access" allowed="readonly readwrite"/>
  -        <attribute name="attributes"/>
  -        <attribute name="auto-delete" allowed="true false none link object"/>
  -        <attribute name="auto-retrieve" allowed="true false"/>
  -        <attribute name="auto-update" allowed="true false none link object"/>
  -        <attribute name="autoincrement" allowed="none ojb database"/>
  -        <attribute name="class-ref"/>
  -        <attribute name="collection-class"/>
  -        <attribute name="column"/>
  -        <attribute name="conversion"/>
  -        <attribute name="default-fetch" allowed="true false"/>
  -        <attribute name="documentation"/>
  -        <attribute name="element-class-ref"/>
  -        <attribute name="foreignkey" required="true"/>
  -        <attribute name="id"/>
  -        <attribute name="ignore" allowed="true false"/>
  -        <attribute name="indexed" allowed="true false"/>
  -        <attribute name="jdbc-type"/>
  -        <attribute name="length"/>
  -        <attribute name="locking" allowed="true false"/>
  -        <attribute name="name" required="true"/>
  -        <attribute name="nullable" allowed="true false"/>
  -        <attribute name="orderby"/>
  -        <attribute name="otm-dependent" allowed="true false"/>
  -        <attribute name="precision"/>
  -        <attribute name="primarykey" allowed="true false"/>
  -        <attribute name="proxy" allowed="true false"/>
  -        <attribute name="proxy-prefetching-limit"/>
  -        <attribute name="query-customizer"/>
  -        <attribute name="query-customizer-attributes"/>
  -        <attribute name="refresh" allowed="true false"/>
  -        <attribute name="scale"/>
  -        <attribute name="sequence-name"/>
  -        <attribute name="update-lock" allowed="true false"/>
  +                   allowed="true false"
  +                   doc="For ODMG: specifies whether implicit locks propagate to this class,
with a value of false, this class can never be locked; default value is 'true'"/>
  +        <attribute name="attributes"
  +                   doc="Contains attributes of the class as name-value pairs of the form
'name1=value1,name2=value2'"/>
  +        <attribute name="determine-extents"
  +                   allowed="true false"
  +                   doc="Whether the XDoclet OJB module should determine the extents (direct
subtypes); default value is 'true'"/>
  +        <attribute name="documentation"
  +                   doc="Documentation for the class"/>
  +        <attribute name="factory-class"
  +                   doc="A different class that is used to create instances of this class"/>
  +        <attribute name="factory-method"
  +                   doc="A usually static method in the factory-class that creates new instances
of this class"/>
  +        <attribute name="generate-table-info"
  +                   allowed="true false"
  +                   doc="Whether this class should be present in the database"/>
  +        <attribute name="include-inherited"
  +                   allowed="true false"
  +                   doc="Whether the XDoclet OJB module should automatically copy all persistent
fields/references/collections from the superclasses into the descriptor for this class; default
value is 'true'"/>
  +        <attribute name="initialization-method"
  +                   doc="This method will be called whenever a new instance of this class
has been created by OJB"/>
  +        <attribute name="isolation-level"
  +                   allowed="read-uncommitted read-committed repeatable-read serializable
optimistic"
  +                   doc="For ODMG: the transactional isolation level; default is 'read-uncommitted'"/>
  +        <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"
  +                   doc="Determines how many objects are prefetched when a collection of
this type is read from the database; use 0 to turn this off"/>
  +        <attribute name="refresh"
  +                   allowed="true false"
  +                   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="table"
  +                   doc="The database table onto which this class is mapped"/>
  +    </tag>
  +    <tag name="@ojb.extent-class"
  +         target="class"
  +         doc="Specifies an extent, a subclass with an @ojb.class tag. This tag is only
evaluated if the value of the determine-extents attribute of this class is set to 'false'">
  +        <attribute name="class-ref"
  +                   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">
  +        <attribute name="access"
  +                   allowed="readonly readwrite"
  +                   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="auto-delete"
  +                   allowed="true false none link object"
  +                   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"
  +                   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"
  +                   doc="For collections: modifies the 'collection-class' attribute of the
inherited feature"/>
  +        <attribute name="column"
  +                   doc="For fields: modifies the 'column' attribute of the inherited feature"/>
  +        <attribute name="conversion"
  +                   doc="For fields: modifies the 'conversion' attribute of the inherited
feature"/>
  +        <attribute name="default-fetch"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'default-fetch' attribute of the inherited
feature"/>
  +        <attribute name="documentation"
  +                   doc="For fields, references, collections: modifies the 'documentation'
attribute of the inherited feature"/>
  +        <attribute name="element-class-ref"
  +                   doc="For collections: modifies the 'element-class-ref' attribute of
the inherited feature"/>
  +        <attribute name="foreignkey"
  +                   required="true"
  +                   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"
  +                   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"/>
  +        <attribute name="locking"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'locking' attribute of the inherited feature"/>
  +        <attribute name="name"
  +                   required="true"
  +                   doc="The name of the inherited feature that will be modified for the
current class"/>
  +        <attribute name="nullable"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'nullable' attribute of the inherited
feature"/>
  +        <attribute name="orderby"
  +                   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"/>
  +        <attribute name="precision"
  +                   doc="For fields: modifies the 'precision' attribute of the inherited
feature"/>
  +        <attribute name="primarykey"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'primarykey' attribute of the inherited
feature"/>
  +        <attribute name="proxy"
  +                   allowed="true false"
  +                   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"/>
  +        <attribute name="scale"
  +                   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="update-lock"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'update-lock' attribute of the inherited
feature"/>
  +    </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">
  +        <attribute name="documentation"
  +                   doc="Documentation for the index"/>
  +        <attribute name="fields"
  +                   required="true"
  +                   doc="Specifies the fields of this class in a comma-separated list that
make up the index"/>
  +        <attribute name="name"
  +                   required="true"
  +                   doc="The name of the index"/>
  +        <attribute name="unique"
  +                   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">
  +        <attribute name="access"
  +                   allowed="readonly readwrite"
  +                   doc="Specifies whether OJB can modify the value of the column that corresponds
to this field"/>
  +        <attribute name="attributes"
  +                   doc="Contains attributes of the field as name-value pairs of the form
'name1=value1,name2=value2'"/>
  +        <attribute name="autoincrement"
  +                   allowed="none ojb database"
  +                   doc="Defines the source of the value for this field. 'None' means that
the value is application-provided, with 'ojb' the value is generated by the current sequence
manager, and 'database' stands for a value that is generated by the database. Default value
is 'none'"/>
  +        <attribute name="column"
  +                   doc="The database column that this field is mapped to"/>
  +        <attribute name="conversion"
  +                   doc="Specifies a class that converts the field value to the type of
the column and vice versa"/>
  +        <attribute name="default-fetch"
  +                   allowed="true false"
  +                   doc="For JDO: Whether this field belongs to a JDO default fetch group;
default value is 'false'"/>
  +        <attribute name="documentation"
  +                   doc="Documentation for the field"/>
  +        <attribute name="id"
  +                   doc="Gives the ordering of the fields in the generated descriptor"/>
  +        <attribute name="indexed"
  +                   allowed="true false"
  +                   doc="Specifies whether there is an index on this field (the default
index). Default value is 'false'"/>
  +        <attribute name="jdbc-type"
  +                   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"/>
  +        <attribute name="locking"
  +                   allowed="true false"
  +                   doc="Declares that this field is used for optimistic locking. Can only
be set for field with a jdbc type of TIMESTAMP or INTEGER. Default value is 'false'"/>
  +        <attribute name="name"
  +                   doc="The name of the field. Only relevant for anonymous fields which
are declared in the javadoc of the class because they have no corresponding java field"/>
  +        <attribute name="nullable"
  +                   allowed="true false"
  +                   doc="Whether the column corresponding to this field can contain 'null'
values"/>
  +        <attribute name="precision"
  +                   doc="Gives the precision setting if the jdbc type of the column requires
it"/>
  +        <attribute name="primarykey"
  +                   allowed="true false"
  +                   doc="Whether this field is part of the primarykey of the class. Default
value is 'false'"/>
  +        <attribute name="scale"
  +                   doc="Gives the scale setting if the jdbc type of the column requires
it"/>
  +        <attribute name="sequence-name"
  +                   doc="The name of the sequence that gives the values for this field if
autoincrement is set to 'ojb'"/>
  +        <attribute name="update-lock"
  +                   allowed="true false"
  +                   doc="If locking is set to 'true' then this attribute specifies whether
OJB will update this locking field or the database. Default is 'true' meaning that OJB does
the update"/>
  +    </tag>
  +    <tag name="@ojb.reference"
  +         target="class method field"
  +         doc="">
  +        <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"
  +                   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"
  +                   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"/>
  +        <attribute name="documentation"
  +                   doc="Documentation for the reference"/>
  +        <attribute name="foreignkey"
  +                   required="true"
  +                   doc="Specifies the fields (comma-separated list) in this class that
hold the primarykey value of the referenced object"/>
  +        <attribute name="otm-dependent"
  +                   allowed="true false"
  +                   doc="Specifies whether the OTM layer automatically creates the referred
object or deletes it if the reference field is set to null. Default value is 'false'"/>
  +        <attribute name="proxy"
  +                   allowed="true false"
  +                   doc="Whether to use proxy-based lazy loading for this reference. Default
value is 'false'"/>
  +        <attribute name="proxy-prefetching-limit"
  +                   doc="Specifies how many objects are prefetched when loading the reference
for the first instance of this class when part of some collection. Set to 0 to disable this"/>
  +        <attribute name="refresh"
  +                   allowed="true false"
  +                   doc="Forces OJB to refresh the reference when the object is reloaded;
default value is 'false'"/>
  +    </tag>
  +    <tag name="@ojb.collection"
  +         target="method field"
  +         doc="">
  +        <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"
  +                   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"
  +                   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"/>
  +        <attribute name="documentation"
  +                   doc="Documentation for the collection"/>
  +        <attribute name="element-class-ref"
  +                   doc="The fully qualified name of the type of the elements which is required
to have an @ojb.class tag"/>
  +        <attribute name="foreignkey"
  +                   required="true"
  +                   doc="Specifies a comma-separated list of the fields in the element type
(1:n collection) or columns in the indirection table (m:n collection) that point to this class
by containing the primarykey value"/>
  +        <attribute name="indirection-table"
  +                   doc="Contains the name of the indirection table for m:n collections"/>
  +        <attribute name="orderby"
  +                   doc="Specifies the fields that define the ordering of the collection,
in the form 'field1=ASC,field2=DESC' with ASC for ascending and DESC for descending ordering"/>
  +        <attribute name="otm-dependent"
  +                   allowed="true false"
  +                   doc="Specifies whether the OTM layer automatically creates collection
elements that were included into the collectionelements and deletes collection elements that
were excluded from the collection. Default value is 'false'"/>
  +        <attribute name="proxy"
  +                   allowed="true false"
  +                   doc="Whether to use proxy-based lazy loading for this collection. Default
value is 'false'"/>
  +        <attribute name="proxy-prefetching-limit"
  +                   doc="Specifies how many objects are prefetched when loading the collection
for the first instance of this class when part of some collection. Set to 0 to disable this"/>
  +        <attribute name="query-customizer"
  +                   doc="Contains the fully qualified name of a class that customizes the
original query that would load this collection"/>
  +        <attribute name="query-customizer-attributes"
  +                   doc="Contains attributes for the query customizer as name-value pairs
of the form 'name1=value1,name2=value2'"/>
  +        <attribute name="refresh"
  +                   allowed="true false"
  +                   doc="Forces OJB to refresh the collection when the object is reloaded;
default value is 'false'"/>
  +        <attribute name="remote-foreignkey"
  +                   doc="Use this attribute for m:n collections to specify the columns in
the indirection table that point to the element type in cases where the element type has no
collection pointing to this class"/>
  +    </tag>
  +    <tag name="@ojb.nested"
  +         target="method field"
  +         doc=""/>
  +    <tag name="@ojb.modify-nested"
  +         target="method field"
  +         doc="Use this tag to modify attributes of nested fields/references/collections">
  +        <attribute name="access"
  +                   allowed="readonly readwrite"
  +                   doc="For fields: modifies the 'access' attribute of the nested feature"/>
  +        <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"
  +                   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"
  +                   doc="For references, collections: modifies the 'auto-update' attribute
of the nested feature"/>
  +        <attribute name="autoincrement"
  +                   allowed="none ojb database"
  +                   doc="For fields: modifies the 'autoincrement' attribute of the nested
feature"/>
  +        <attribute name="class-ref"
  +                   doc="For references: modifies the 'class-ref' attribute of the nested
feature"/>
  +        <attribute name="collection-class"
  +                   doc="For collections: modifies the 'collection-class' attribute of the
nestedfeature"/>
  +        <attribute name="column"
  +                   doc="For fields: modifies the 'column' attribute of the nested feature"/>
  +        <attribute name="conversion"
  +                   doc="For fields: modifies the 'conversion' attribute of the nested feature"/>
  +        <attribute name="default-fetch"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'default-fetch' attribute of the nested
feature"/>
  +        <attribute name="documentation"
  +                   doc="For fields, references, collections: modifies the 'documentation'
attribute of the nested feature"/>
  +        <attribute name="element-class-ref"
  +                   doc="For collections: modifies the 'element-class-ref' attribute of
the nested feature"/>
  +        <attribute name="foreignkey"
  +                   required="true"
  +                   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"
  +                   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"/>
  +        <attribute name="locking"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'locking' attribute of the nested feature"/>
  +        <attribute name="name"
  +                   required="true"
  +                   doc="The name of the nested feature that will be modified for the current
class"/>
  +        <attribute name="nullable"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'nullable' attribute of the nested feature"/>
  +        <attribute name="orderby"
  +                   doc="For collection: modifies the 'orderby' attribute of the nested
feature"/>
  +        <attribute name="otm-dependent"
  +                   allowed="true false"
  +                   doc="For references, collections: modifies the 'otm-dependent' attribute
of the nested feature"/>
  +        <attribute name="precision"
  +                   doc="For fields: modifies the 'precision' attribute of the nested feature"/>
  +        <attribute name="primarykey"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'primarykey' attribute of the nested feature"/>
  +        <attribute name="proxy"
  +                   allowed="true false"
  +                   doc="For references, collections: modifies the 'proxy' attribute of
the nested feature"/>
  +        <attribute name="proxy-prefetching-limit"
  +                   doc="For references, collections: modifies the 'proxy-prefetching-limit'
attribute of the nested feature"/>
  +        <attribute name="query-customizer"
  +                   doc="For collections: modifies the 'query-customizer' attribute of the
nested feature"/>
  +        <attribute name="query-customizer-attributes"
  +                   doc="For collections: modifies the 'query-customizer-attributes' attribute
of the nested feature"/>
  +        <attribute name="refresh"
  +                   allowed="true false"
  +                   doc="For references, collections: modifies the 'refresh' attribute of
the nested feature"/>
  +        <attribute name="scale"
  +                   doc="For fields: modifies the 'scale' attribute of the nested feature"/>
  +        <attribute name="sequence-name"
  +                   doc="For fields: modifies the 'sequence-name' attribute of the nested
feature"/>
  +        <attribute name="update-lock"
  +                   allowed="true false"
  +                   doc="For fields: modifies the 'update-lock' attribute of the nested
feature"/>
       </tag>
   </doclipse>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org


Mime
View raw message