db-ojb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From arm...@apache.org
Subject cvs commit: db-ojb/forrest/src/documentation skinconf.xml
Date Wed, 09 Jun 2004 00:57:31 GMT
arminw      2004/06/08 17:57:31

  Modified:    forrest/src/documentation/content/xdocs/docu
                        basic-technique.xml logging.xml objectcache.xml
                        sequencemanager.xml
               forrest/src/documentation skinconf.xml
  Log:
  - replace "Note:" statements with <note> tags
  - rise font size for note,fixme,warning tags
  
  Revision  Changes    Path
  1.8       +26 -17    db-ojb/forrest/src/documentation/content/xdocs/docu/basic-technique.xml
  
  Index: basic-technique.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/docu/basic-technique.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- basic-technique.xml	17 May 2004 23:42:27 -0000	1.7
  +++ basic-technique.xml	9 Jun 2004 00:57:31 -0000	1.8
  @@ -895,10 +895,13 @@
                           the referenced objects are NOT updated by default. The referenced
objects will not be
                           <em>inserted</em> or
                           <em>updated</em>, but the m:n relation will be linked
automatically (creation of FK entries in the indirection table).
  -                        <br/>
  -                        NOTE: Make sure that the referenced objects exist in database before
storing the main object
  -                        to avoid violation of referential integrity.
                       </li>
  +                </ul>
  +                <note>
  +                    Make sure that the referenced objects exist in database before storing
the main object
  +                    with auto-update set <em>link</em> to avoid violation of
referential integrity.
  +                </note>
  +                <ul>
                       <li>
                           <strong>object</strong> On updating or inserting of
the main object with
                           <code>PersistenceBroker.store(...)</code>,
  @@ -998,8 +1001,9 @@
                   </li>
               </ul>
               <note>
  -                It is mandatory when using the top-level API's (ODMG, OTM, JDO) to set
the
  -                <em>default</em> auto-XXX settings (or don't specify the attribute)
for proper work.
  +                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.
                   <br/>
                   This may change in future.
               </note>
  @@ -1034,16 +1038,22 @@
   PersistenceBroker.retrieveAllReferences(Object obj);]]></source>
                           The first method load only the specified reference, the second
one loads all references declared
                           for the given object.
  -                        <br/>
  -                        <strong>NOTE:</strong> Be careful when using "opposite"
settings, e.g. if you declare a 1:1 reference with
  -                        auto-retrieve="false" and auto-update="object" (or "true" or "link").
Before you can perform an update
  -                        on the main object, you have to "retrieve" the 1:1 reference. Otherwise
you will end up with an nullified
  -                        reference, because OJB assume the reference was removed.
                       </li>
  +                    </ul>
  +                <note>
  +                    Be careful when using "opposite" settings, e.g. if you declare a 1:1
reference with
  +                    auto-retrieve="false" BUT auto-update="object" (or "true" or "link").
  +                    <br/>
  +                    Before you can perform an update
  +                    on the main object, you have to "retrieve" the 1:1 reference. Otherwise
you will end up with an nullified
  +                    reference enty in main object, because OJB doesn't find the referenced
object on update and
  +                    assume the reference was removed.
  +                </note>
  +                <ul>
                       <li>
                           <strong>true</strong> If set
  -                        <em>true</em> the referenced object (in this case all
n-side objects) will be automatic loaded
  -                        by OJB when the main object was materialized.
  +                        <em>true</em> the referenced objects (single reference
or all n-side objects) will be automatic
  +                        loaded by OJB when the main object was materialized.
                       </li>
                   </ul>
                   <p>
  @@ -1126,13 +1136,12 @@
                   </p>
                   <source><![CDATA[
   BrokerHelper bh = broker.serviceBrokerHelper();]]></source>
  -                <p>
  -                    <strong>NOTE:</strong> The
  -                    <em>link/unlink</em> methods are only useful if you set
auto-update/-delete to
  +                <note>
  +                    The <em>link/unlink</em> methods are only useful if you
set auto-update/-delete to
                       <em>none</em>. In
                       all other cases OJB handles the link/unlink of references internally.
It is also possible to set all FK values by
                       hand without using the link/unlink service methods.
  -                </p>
  +                </note>
                   <p>
                       <strong>Examples</strong>
                       <br/>
  
  
  
  1.3       +7 -7      db-ojb/forrest/src/documentation/content/xdocs/docu/logging.xml
  
  Index: logging.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/docu/logging.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- logging.xml	7 Jun 2004 20:00:55 -0000	1.2
  +++ logging.xml	9 Jun 2004 00:57:31 -0000	1.3
  @@ -210,10 +210,10 @@
   # Configuration file of the log
   log4j.configuration=log4j.properties
   ]]></source>
  -                <p>
  -                    <strong>Note:</strong> Since commons-logging provides the
same function as the logging
  +                <note>
  +                    Since commons-logging provides the same function as the logging
                       component of OJB, it will likely be used as OJB's logging component
in the near future.
  -                </p>
  +                </note>
               </section>
               <section>
                   <title>log4j.properties</title>
  @@ -339,13 +339,13 @@
                   is used to initialize the logger with the logging properties (as contained
in
                   <code>OJB-logging.properties</code>).
               </p>
  -            <p>
  -                <strong>Note:</strong> Because commons-logging performs a similar
function to
  +            <note>
  +                Because commons-logging performs a similar function to
                   the OJB logging component, it is likely that it will be used as such in
the near
                   future. Therefore you're encouraged to also implement the
                   <link href="ext:jakarta/commons-logging/api-log">Log</link>
interface which is
                   nearly the same as the <link href="ext:api/logger">Logger</link>
interface.
  -            </p>
  +            </note>
           </section>
       </body>
   </document>
  
  
  
  1.6       +2 -2      db-ojb/forrest/src/documentation/content/xdocs/docu/objectcache.xml
  
  Index: objectcache.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/docu/objectcache.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- objectcache.xml	12 May 2004 16:06:11 -0000	1.5
  +++ objectcache.xml	9 Jun 2004 00:57:31 -0000	1.6
  @@ -281,7 +281,7 @@
                               cache. Default is
                               <em>false</em>.
                               <p>
  -                                NOTE: This does not prevent "dirty-reads" by concurrent
threads (more info see above).
  +                                <strong>NOTE:</strong> This does not prevent
"dirty-reads" by concurrent threads (more info see above).
                               </p>
                               <p>
                                   It's not a smart solution for keeping cache in sync with
DB but should do the job
  
  
  
  1.4       +5 -4      db-ojb/forrest/src/documentation/content/xdocs/docu/sequencemanager.xml
  
  Index: sequencemanager.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/docu/sequencemanager.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- sequencemanager.xml	28 Apr 2004 08:03:52 -0000	1.3
  +++ sequencemanager.xml	9 Jun 2004 00:57:31 -0000	1.4
  @@ -804,11 +804,12 @@
                           <code>field-descriptor</code>,
                           there is no reason to obtain UID directly from the sequence manager
or to handle
                           UID in your object model.
  -                        <br/>
  -                        [NOTE: Don't use SequenceManagerFactory#getSequenceManager(PersistenceBroker
broker), this
  +                    </p>
  +                    <note>
  +                        Don't use SequenceManagerFactory#getSequenceManager(PersistenceBroker
broker), this
                           method returns a new sequence manager instance for the given broker
instance and not the current
                           used SM instance of the given PersistenceBroker instance]
  -                    </p>
  +                    </note>
                   </section>
   
   
  
  
  
  1.5       +3 -3      db-ojb/forrest/src/documentation/skinconf.xml
  
  Index: skinconf.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/skinconf.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- skinconf.xml	17 May 2004 23:42:27 -0000	1.4
  +++ skinconf.xml	9 Jun 2004 00:57:31 -0000	1.5
  @@ -110,9 +110,9 @@
   	padding: 1em 1.33em 1em 1.33em;
   	background : #EEEEEE;}
   .codefrag   {font-family: "Courier New", Courier, monospace; font-size : 100%;}
  -.warningmessage {font-size : 85%;}
  -.infomessage {font-size : 85%;}
  -.errormessage {font-size : 85%;}
  +.warningmessage {font-size : 90%;}
  +.infomessage {font-size : 90%;}
  +.errormessage {font-size : 90%;}
        </extra-css>
   
       <colors>
  
  
  

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