You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ojb-dev@db.apache.org by ar...@apache.org on 2005/03/18 23:29:27 UTC

cvs commit: db-ojb/src/doc/forrest/src/documentation/content/xdocs index.xml status.xml

arminw      2005/03/18 14:29:27

  Modified:    src/doc/forrest/src/documentation/content/xdocs/docu/guides
                        Tag: OJB_1_0_RELEASE basic-technique.xml
                        repository.xml
               src/doc/forrest/src/documentation/content/xdocs/docu/tutorials
                        Tag: OJB_1_0_RELEASE odmg-tutorial.xml
               src/doc/forrest/src/documentation/content/xdocs Tag:
                        OJB_1_0_RELEASE index.xml status.xml
  Log:
  update docs, changed odmg-api auto-xxx settings
  
  Revision  Changes    Path
  No                   revision
  No                   revision
  1.1.2.2   +15 -7     db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml
  
  Index: basic-technique.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- basic-technique.xml	27 Jul 2004 00:29:31 -0000	1.1.2.1
  +++ basic-technique.xml	18 Mar 2005 22:29:26 -0000	1.1.2.2
  @@ -1011,13 +1011,21 @@
                       <em>false</em>
                   </li>
               </ul>
  -            <note>
  -                When using a top-level api (ODMG, OTM, JDO) it is mandatory to use the
  -                <em>default</em> auto-XXX settings (or don't specify the attributes)
  -                for proper work.
  +            <warning>
  +                When using a top-level api (ODMG, OTM, JDO) it is <strong>mandatory to use specific
  +                auto-xxx settings</strong>.<br/>
  +                <br/>For OTM- and JDO-api the settings are:
  +                <br/>- <em>auto-retrieve="true"</em>
  +                <br/>- <em>auto-update="false"</em>
  +                <br/>- <em>auto-retrieve="false"</em>
  +                <br/>This are at the same time the <em>default</em> auto-XXX settings (so don't
  +                specify any of this attributes will have the same effect).
                   <br/>
  -                This may change in future.
  -            </note>
  +                <br/>For the ODMG-api the mandatory settings are (since OJB 1.0.2):
  +                <br/>- <em>auto-retrieve="true"</em>
  +                <br/>- <em>auto-update="none"</em>
  +                <br/>- <em>auto-retrieve="none"</em>
  +            </warning>
               <p>
                   The attribute
                   <em>auto-update</em> and
  
  
  
  1.1.2.4   +35 -31    db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml
  
  Index: repository.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- repository.xml	9 Mar 2005 15:23:05 -0000	1.1.2.3
  +++ repository.xml	18 Mar 2005 22:29:26 -0000	1.1.2.4
  @@ -1085,7 +1085,8 @@
                       More info about the <link href="site:basic-technique/cascading">auto-XXX settings here</link>.
                   </p>
                   <note>
  -                    This attribute must be set to false if using the OTM, ODMG or JDO layer.
  +                    This attribute must be set to <em>false</em> if using the OTM or JDO layer.
  +                    <br/> For ODMG-api <em>none</em> is mandatory (since OJB 1.0.2).
                   </note>
                   <p>
                       The <em>auto-delete</em> attribute specifies whether OJB automatically deletes
  @@ -1094,7 +1095,8 @@
                       More info about the <link href="site:basic-technique/cascading">auto-XXX settings here</link>.
                   </p>
                   <note>
  -                    This attribute must be set to false if using the OTM, ODMG or JDO layer.
  +                    This attribute must be set to <em>false</em> if using the OTM or JDO layer.
  +                    <br/> For ODMG-api <em>none</em> is mandatory (since OJB 1.0.2).
                   </note>
                   <p>
                       The <em>otm-dependent</em> attribute specifies whether the OTM layer automatically
  @@ -1105,17 +1107,17 @@
                   </p>
                   <source><![CDATA[
   <!ATTLIST reference-descriptor
  -    name CDATA #REQUIRED
  -    class-ref IDREF #REQUIRED
  +	name CDATA #REQUIRED
  +	class-ref IDREF #REQUIRED
   
  -    proxy (true | false) "false"
  -    proxy-prefetching-limit CDATA #IMPLIED
  -    refresh (true | false) "false"
  -
  -    auto-retrieve (true | false) "true"
  -    auto-update (true | false) "false"
  -    auto-delete (true | false) "false"
  -    otm-dependent (true | false) "false"
  +	proxy (true | false) "false"
  +	proxy-prefetching-limit CDATA #IMPLIED
  +	refresh (true | false) "false"
  +
  +	auto-retrieve (true | false) "true"
  +	auto-update (none | link | object | true | false) "false"
  +	auto-delete (none | link | object | true | false) "false"
  +	otm-dependent (true | false) "false"
   >]]></source>
               </section>
   
  @@ -1250,7 +1252,8 @@
                       More info about the <link href="site:basic-technique/cascading">auto-XXX settings here</link>.
                   </p>
                   <note>
  -                    This attribute must be set to false if using the OTM, ODMG or JDO layer.
  +                    This attribute must be set to <em>false</em> if using the OTM or JDO layer.
  +                    <br/> For ODMG-api <em>none</em> is mandatory (since OJB 1.0.2).
                   </note>
                   <p>
                       The <em>auto-delete</em> attribute specifies whether OJB automatically deletes
  @@ -1259,7 +1262,8 @@
                       More info about the <link href="site:basic-technique/cascading">auto-XXX settings here</link>.
                   </p>
                   <note>
  -                    This attribute must be set to false if using the OTM, ODMG or JDO layer.
  +                    This attribute must be set to <em>false</em> if using the OTM or JDO layer.
  +                    <br/> For ODMG-api <em>none</em> is mandatory (since OJB 1.0.2).
                   </note>
                   <p>
                       The <em>otm-dependent</em> attribute specifies whether the OTM layer automatically
  @@ -1271,22 +1275,22 @@
                   </p>
                   <source><![CDATA[
   <!ATTLIST collection-descriptor
  -    name CDATA #IMPLIED
  -    collection-class CDATA #IMPLIED
  -    element-class-ref IDREF #REQUIRED
  -    orderby CDATA #IMPLIED
  -    sort (ASC | DESC) "ASC"
  -
  -    indirection-table CDATA #IMPLIED
  -
  -    proxy (true | false) "false"
  -    proxy-prefetching-limit CDATA #IMPLIED
  -    refresh (true | false) "false"
  -
  -    auto-retrieve (true | false) "true"
  -    auto-update (true | false) "false"
  -    auto-delete (true | false) "false"
  -    otm-dependent (true | false) "false"
  +	name CDATA #IMPLIED
  +	collection-class CDATA #IMPLIED
  +	element-class-ref IDREF #REQUIRED
  +	orderby CDATA #IMPLIED
  +	sort (ASC | DESC) "ASC"
  +
  +	indirection-table CDATA #IMPLIED
  +
  +	proxy (true | false) "false"
  +	proxy-prefetching-limit CDATA #IMPLIED
  +	refresh (true | false) "false"
  +
  +	auto-retrieve (true | false) "true"
  +	auto-update (none | link | object | true | false) "false"
  +	auto-delete (none | link | object | true | false) "false"
  +	otm-dependent (true | false) "false"
   >]]></source>
               </section>
   
  
  
  
  No                   revision
  No                   revision
  1.1.2.3   +7 -1      db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/tutorials/odmg-tutorial.xml
  
  Index: odmg-tutorial.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/tutorials/odmg-tutorial.xml,v
  retrieving revision 1.1.2.2
  retrieving revision 1.1.2.3
  diff -u -r1.1.2.2 -r1.1.2.3
  --- odmg-tutorial.xml	23 Jan 2005 03:09:13 -0000	1.1.2.2
  +++ odmg-tutorial.xml	18 Mar 2005 22:29:27 -0000	1.1.2.3
  @@ -61,6 +61,12 @@
                   <link href="site:mapping-tutorial">mapping tutorial</link>
               </p>
               <p>
  +                When using 1:1, 1:n and m:n references the ODMG-api need specific metadata
  +                settings on relationship definition - more info see
  +                <link href="site:basic-technique/cascading">auto-xxx settings</link> and
  +                <link href="site:repository">repository file settings</link>.
  +            </p>
  +            <p>
                   As with the other tutorials, the source code for this tutorial is
                   contained in the <code>tutorials-src.jar</code> which can be downloaded
                   <link href="ext:ojb/binaries-version">here</link>. The source files
  
  
  
  No                   revision
  No                   revision
  1.1.2.2   +2 -1      db-ojb/src/doc/forrest/src/documentation/content/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/index.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- index.xml	23 Jan 2005 03:09:13 -0000	1.1.2.1
  +++ index.xml	18 Mar 2005 22:29:27 -0000	1.1.2.2
  @@ -71,6 +71,7 @@
                   <p>
                       See
                       <link href="site:faq/apis">the FAQ</link> for a detailed view of the OJB layering.
  +                    API's <link href="site:status">status here</link>. 
                   </p>
   
               </section>
  
  
  
  1.1.2.2   +9 -9      db-ojb/src/doc/forrest/src/documentation/content/xdocs/status.xml
  
  Index: status.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/status.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- status.xml	23 Jan 2005 03:09:13 -0000	1.1.2.1
  +++ status.xml	18 Mar 2005 22:29:27 -0000	1.1.2.2
  @@ -31,24 +31,22 @@
           <section>
               <title>PB API (Persistence Broker API)</title>
               <p>
  -                The PB API implementation is <strong>stable</strong>.
  +                The PB API implementation is <strong>stable</strong>, known
  +                issues can be found in
  +                <link href="ext:release-notes">release-notes</link>.
               </p>
           </section>
   
           <section>
               <title>ODMG API</title>
               <p>
  -                The ODMG API implementation is <strong>stable</strong>, but there some <strong>known
  -                issues</strong> - see
  +                The ODMG API implementation is <strong>stable</strong>, known
  +                issues can be found in
                   <link href="ext:release-notes">release-notes</link>.
               </p>
               <note>
                   OQL is currently not
                   fully implemented (Aggregations and Method Invocations).
  -                <br/>
  -                ODMG implicit locking is partly implemented but does currently not
  -                maintain transaction isolation properly. To achieve safe transaction
  -                isolation client application must use explicit lock acquisition.
               </note>
   
           </section>
  @@ -57,7 +55,9 @@
               <title>JDO API</title>
               <p>
                   By providing a plugin to the SUN JDO Reference Implementation we provide
  -                a complete JDO 1.0.1 <strong>prototype</strong> O/R mapping tool.
  +                a complete JDO 1.0.1 <strong>prototype</strong> O/R mapping tool. Integration in
  +                <em>managed environments</em> (in particular JTA integration) is not supported for JDO 1.0 prototype.
  +                <br/>
                   A complete Apache licensed JDO 2.0 implementation is scheduled for OJB 2.0.
               </p>
           </section>
  
  
  

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