ojb-dev@db.apache.org
[Top] [All Lists]

cvs commit: db-ojb/src/doc/forrest/src/documentation/content/xdocs site.

Subject: cvs commit: db-ojb/src/doc/forrest/src/documentation/content/xdocs site.xml
From:
Date: 19 Dec 2004 02:48:42 -0000
arminw      2004/12/18 18:48:42

  Modified:    src/doc/forrest/src/documentation/content/xdocs/docu/guides
                        advanced-technique.xml
               src/doc/forrest/src/documentation/content/xdocs/docu/howtos
                        howto-use-ojb-with-springframework.xml
               src/doc/forrest/src/documentation/content/xdocs/docu faq.xml
               src/doc/forrest/src/documentation/content/xdocs site.xml
  Log:
  fix links
  update docs
  
  Revision  Changes    Path
  1.3       +32 -36    
db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml
  
  Index: advanced-technique.xml
  ===================================================================
  RCS file: 
/home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- advanced-technique.xml    15 Aug 2004 13:55:09 -0000      1.2
  +++ advanced-technique.xml    19 Dec 2004 02:48:42 -0000      1.3
  @@ -1201,7 +1201,7 @@
                       object's table. This approach is also called 'nested 
objects'.
                       The section
                       <link href="#nested-objects">nested objects</link> 
contains a
  -                    different and much simpler approach to implement nested 
fields.
  +                    different and <strong>much simpler approach</strong> to 
implement nested fields.
                   </p>
                   <p>
                       The class
  @@ -1223,37 +1223,39 @@
                       follows:
                   </p>
                   <source><![CDATA[
  -public Object readObjectFrom(Map row, ClassDescriptor cld)
  +public Object readObjectFrom(Map row)
   {
  -    Object result = super.readObjectFrom(row, cld);
  +    Object result = super.readObjectFrom(row);
       if (result instanceof ArticleWithStockDetail)
       {
           ArticleWithStockDetail art = (ArticleWithStockDetail) result;
  -        boolean sellout = art.isSelloutArticle;
  -        int minimum = art.minimumStock;
  -        int ordered = art.orderedUnits;
  -        int stock = art.stock;
  -        String unit = art.unit;
  -        StockDetail detail = new StockDetail(sellout, minimum,
  -                                    ordered, stock, unit, art);
  -        art.stockDetail = detail;
  +        // create the nested detail object
  +        StockDetail detail = new StockDetail(art);
  +        // set the nested detail object
  +        art.setStockDetail(detail);
           return art;
       }
       else
       {
           return result;
       }
  +}
   }]]></source>
                   <p>
  -                    To activate this RowReader the ClassDescriptor for the 
class
  -                    ArticleWithStockDetail contains the following entry:
  +                    To activate this <code>RowReader</code> implementation, 
the ClassDescriptor for the class
  +                    <code>ArticleWithStockDetail</code> contains the 
following entry:
                   </p>
  -                <source><![CDATA[
  +<source><![CDATA[
   <class-descriptor
     class="org.apache.ojb.broker.ArticleWithStockDetail"
     table="Artikel"
     row-reader="org.apache.ojb.broker.RowReaderTestImpl"
  ->]]></source>
  +>
  +...
  +]]></source>
  +                <p>
  +                    With the <code>row-reader</code> attribute the 
<code>RowReader</code> was specified.
  +                </p>
               </section>
           </section>
   
  @@ -1286,39 +1288,34 @@
                   has a
                   <code>stockDetail</code>
                   attribute, holding a reference to a
  -                <code>StockDetail</code>
  -                object. The class StockDetail is not declared in the XML 
repository as
  -                a first class entity class.
  +                <code>StockDetailNested</code>
  +                object.
               </p>
  -
  -            <source><![CDATA[
  +<source><![CDATA[
   public class ArticleWithNestedStockDetail implements java.io.Serializable
   {
       /**
        * this attribute is not filled through a reference lookup
        * but with the nested fields feature
        */
  -    protected StockDetail stockDetail;
  +    protected StockDetailNested stockDetail;
   
       ...
   }]]></source>
               <p>
  -                The
  +                The class <code>StockDetailNested</code> is not declared in 
the XML repository as
  +                a first class entity class. It's a helper class to merge 
fields which in relationship, e.g.
  +                for an Article class fields like Unit, Stock, ... . The
                   <em>StockDetail</em> class has the following layout:
               </p>
               <source><![CDATA[
  -public class StockDetail implements java.io.Serializable
  +public class StockDetailNested implements java.io.Serializable
   {
  -    protected boolean isSelloutArticle;
  -
  -    protected int minimumStock;
  -
  -    protected int orderedUnits;
  -
  -    protected int stock;
  -
  -    protected String unit;
  -
  +    private boolean isSelloutArticle;
  +    private int minimumStock;
  +    private int orderedUnits;
  +    private int stock;
  +    private String unit;
       ...
   }]]></source>
               <p>
  @@ -1389,8 +1386,7 @@
     />
   </class-descriptor>]]></source>
               <p>
  -                That's all!
  -                Just add nested fields by using
  +                That's all! Just add nested fields by using
                   <code>::</code> to specify attributes of the
                   nested object.
                   All aspects of storing and retrieving the nested object are 
managed by OJB.
  
  
  
  1.3       +2 -2      
db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-ojb-with-springframework.xml
  
  Index: howto-use-ojb-with-springframework.xml
  ===================================================================
  RCS file: 
/home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-ojb-with-springframework.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- howto-use-ojb-with-springframework.xml    8 Dec 2004 21:56:17 -0000       
1.2
  +++ howto-use-ojb-with-springframework.xml    19 Dec 2004 02:48:42 -0000      
1.3
  @@ -32,7 +32,7 @@
                   <title>Introduction</title>
                   <p>
                   You can spend the good part of a day working out the ins and 
outs of the
  -                <link href="ext:spring">Springframework</link> and <link 
href="site:ojb">OJB</link>.
  +                <link href="ext:spring">Springframework</link> and <link 
href="site:ojb/index">OJB</link>.
                   There is a fair level of complexity involved while you come 
up to speed with the Springframework,
                   but once it's done and working, you will realize how simple 
it really is.
                   </p>
  
  
  
  1.6       +5 -2      
db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/faq.xml
  
  Index: faq.xml
  ===================================================================
  RCS file: 
/home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/faq.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- faq.xml   16 Dec 2004 11:48:08 -0000      1.5
  +++ faq.xml   19 Dec 2004 02:48:42 -0000      1.6
  @@ -662,11 +662,14 @@
                        <li>Don't put OJB's jars into one of the servers 
directories but rather put them into the <code>WEB-INF/lib</code>
                            folder of your web app.</li>
                        <li>OJB searches for its configuration files 
(<code>OJB.properties</code>, <code>repository.xml</code>) in the classpath.
  -                         Therefore, it is easiest if you put them in the 
<code>WEB-INF/classes<code> folder which is automatically in the
  +                         Therefore, it is easiest if you put them in the 
<code>WEB-INF/classes</code> folder which is automatically in the
                            classpath of the web app</li>
                        <li>Don't hold onto the <code>PersistenceBroker</code> 
instances, rather get one whenever you want to do something, and close
                            it once you're done.</li>
                   </ul>
  +                <p>
  +                    See <link href="site:deployment">deployment doc</link> 
for more information.
  +                </p>
               </answer>
           </faq>
   
  
  
  
  1.12      +3 -3      
db-ojb/src/doc/forrest/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: 
/home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- site.xml  10 Dec 2004 00:25:00 -0000      1.11
  +++ site.xml  19 Dec 2004 02:48:42 -0000      1.12
  @@ -172,7 +172,7 @@
               <use-lobs label="Use Oracle LOB's" href="howto-use-lobs.html" 
description=""/>
               <clustering label="Work in clustered environment" 
href="howto-work-with-clustering.html" description=""/>
               <stored-procedures label="Work with Stored Procedures" 
href="howto-work-with-stored-procedures.html" description=""/>
  -            <ojb-with-springframework label="Using OJB with the 
Springframework" href="howto-use-ojb-with-springframework.html" description=""/>
  +            <ojb-spring label="Using OJB with the Springframework" 
href="howto-use-ojb-with-springframework.html" description=""/>
           </howto>
   
           <testing label="Testing" href="testing/" tab="testing">
  @@ -320,7 +320,7 @@
           <nees href="http://www.nees.org/"/>
           <ojb-net href="http://ojb-net.sourceforge.net/"/>
           <yourkit href="http://www.yourkit.com/"; />
  -        <spring href="http://www.springframework.org";>
  +        <spring href="http://www.springframework.org/";>
               <localDataSourceConnectionFactory 
href="docs/api/org/springframework/orm/ojb/support/LocalDataSourceConnectionFactory.html"/>
           </spring>
           <dbuint href="http://dbunit.sourceforge.net"/>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@xxxxxxxxxxxxx
For additional commands, e-mail: ojb-dev-help@xxxxxxxxxxxxx

<Prev in Thread] Current Thread [Next in Thread>