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/doc/forrest/src/documentation/content/xdocs/docu/guides xdoclet-module.xml
Date Sun, 08 May 2005 14:50:50 GMT
tomdz       2005/05/08 07:50:50

  Modified:    .        .classpath release-notes.txt
               src/doc/forrest/src/documentation/content/xdocs/docu/guides
                        xdoclet-module.xml
  Log:
  Updated XDoclet module documentation and release notes
  
  Revision  Changes    Path
  1.50      +0 -1      db-ojb/.classpath
  
  Index: .classpath
  ===================================================================
  RCS file: /home/cvs/db-ojb/.classpath,v
  retrieving revision 1.49
  retrieving revision 1.50
  diff -u -r1.49 -r1.50
  --- .classpath	8 May 2005 14:22:46 -0000	1.49
  +++ .classpath	8 May 2005 14:50:50 -0000	1.50
  @@ -36,7 +36,6 @@
   	<classpathentry kind="lib" path="lib/geronimo-spec-j2ee-1.4-rc2.jar"/>
   	<classpathentry kind="lib" path="lib/p6spy-1.3-patched.jar"/>
   	<classpathentry kind="lib" path="lib/xdoclet-1.2.3.jar"/>
  -	<classpathentry kind="lib" path="lib/xdoclet-ojb-module-1.2.3.jar"/>
   	<classpathentry kind="lib" path="lib/xjavadoc-1.1.jar"/>
   	<classpathentry kind="lib" path="lib/cglib-2.1.jar"/>
   	<classpathentry kind="output" path="target/classes/main"/>
  
  
  
  1.80      +5 -1      db-ojb/release-notes.txt
  
  Index: release-notes.txt
  ===================================================================
  RCS file: /home/cvs/db-ojb/release-notes.txt,v
  retrieving revision 1.79
  retrieving revision 1.80
  diff -u -r1.79 -r1.80
  --- release-notes.txt	27 Apr 2005 19:21:52 -0000	1.79
  +++ release-notes.txt	8 May 2005 14:50:50 -0000	1.80
  @@ -11,6 +11,10 @@
   Release 1.1_alpha
   ---------------------------------------------------------------------
   NEW FEATURES:
  +- It is now possible to use database procedures for retrieving objects by their identity
  +  (primary key values) and by their foreign key values (for elements of a collection).
  +  Two procedure descriptors have been introduced to this end: select-by-pk-procedure
  +  and select-by-fk-procedure. Also, corresponding XDoclet tags are also available.
   - When querying for Proxies the select statement contains the pk-columns only. 
     This feature may help to solve memory problems. 
   - Proxy generation is now pluggable with two implementations (standard Java proxies,
  
  
  
  1.8       +98 -1     db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml
  
  Index: xdoclet-module.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- xdoclet-module.xml	22 Mar 2005 21:36:09 -0000	1.7
  +++ xdoclet-module.xml	8 May 2005 14:50:50 -0000	1.8
  @@ -353,6 +353,10 @@
                       <br/>
                       <link href="#ojb.update-procedure">ojb.update-procedure</link>
                       <br/>
  +                    <link href="#ojb.select-by-pk-procedure">ojb.select-by-pk-procedure</link>
  +                    <br/>
  +                    <link href="#ojb.select-by-fk-procedure">ojb.select-by-fk-procedure</link>
  +                    <br/>
                       <link href="#ojb.constant-argument">ojb.constant-argument</link>
                       <br/>
                       <link href="#ojb.runtime-argument">ojb.runtime-argument</link>
  @@ -1144,6 +1148,99 @@
               </section>
   
               <section>
  +                <title>ojb.select-by-pk-procedure</title>
  +                <p>
  +                    The database procedure that will be used for retrieving objects from
the database using
  +                    the object's identity (primary key values).
  +                </p>
  +                <p>
  +                    <em>Attributes:</em>
  +                </p>
  +                <dl>
  +                    <dt>
  +                        <strong>attributes</strong>
  +                    </dt>
  +                    <dd>
  +                        The optional attributes of the procedure in a comma-separated list
of
  +                        name-value pairs.
  +                        <br/>
  +                    </dd>
  +
  +                    <dt>
  +                        <strong>documentation</strong>
  +                    </dt>
  +                    <dd>
  +                        Optional documentation on the procedure.
  +                        <br/>
  +                    </dd>
  +
  +                    <dt>
  +                        <strong>name</strong>
  +                    </dt>
  +                    <dd>
  +                        Name of the database procedure (required).
  +                        <br/>
  +                    </dd>
  +
  +                    <dt>
  +                        <strong>return-field-ref</strong>
  +                    </dt>
  +                    <dd>
  +                        A persistent field that will receive the return value of the procedure
(only to be used if the
  +                        procedure returns a value).
  +                        <br/>
  +                    </dd>
  +                </dl>
  +            </section>
  +
  +            <section>
  +                <title>ojb.select-by-fk-procedure</title>
  +                <p>
  +                    The database procedure that will be used for retrieving objects from
the database by
  +                    checking the values of the foreign key fields in the database. This
is for instance
  +                    used for the objects that are contained in a collection.
  +                </p>
  +                <p>
  +                    <em>Attributes:</em>
  +                </p>
  +                <dl>
  +                    <dt>
  +                        <strong>attributes</strong>
  +                    </dt>
  +                    <dd>
  +                        The optional attributes of the procedure in a comma-separated list
of
  +                        name-value pairs.
  +                        <br/>
  +                    </dd>
  +
  +                    <dt>
  +                        <strong>documentation</strong>
  +                    </dt>
  +                    <dd>
  +                        Optional documentation on the procedure.
  +                        <br/>
  +                    </dd>
  +
  +                    <dt>
  +                        <strong>name</strong>
  +                    </dt>
  +                    <dd>
  +                        Name of the database procedure (required).
  +                        <br/>
  +                    </dd>
  +
  +                    <dt>
  +                        <strong>return-field-ref</strong>
  +                    </dt>
  +                    <dd>
  +                        A persistent field that will receive the return value of the procedure
(only to be used if the
  +                        procedure returns a value).
  +                        <br/>
  +                    </dd>
  +                </dl>
  +            </section>
  +
  +            <section>
                   <title>ojb.constant-argument</title>
                   <p>
                       A constant argument for a database procedure. These arguments are referenced
by the procedure tags
  
  
  

---------------------------------------------------------------------
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