Quantcast

svn commit: r615700 - in /db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest: ./ src/documentation/content/xdocs/ src/documentation/content/xdocs/docu/ src/documentation/content/xdocs/docu/guides/ src/documentation/content/xdocs/docu/howtos/

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

svn commit: r615700 - in /db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest: ./ src/documentation/content/xdocs/ src/documentation/content/xdocs/docu/ src/documentation/content/xdocs/docu/guides/ src/documentation/content/xdocs/docu/howtos/

Armin Waibel
Author: arminw
Date: Sun Jan 27 18:04:36 2008
New Revision: 615700

URL: http://svn.apache.org/viewvc?rev=615700&view=rev
Log:
update documentation

Modified:
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/forrest.properties
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/objectcache.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/pb-guide.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-spring.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-work-with-clustering.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/site.xml

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/forrest.properties
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/forrest.properties?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/forrest.properties (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/forrest.properties Sun Jan 27 18:04:36 2008
@@ -101,7 +101,7 @@
 project.debuglevel=INFO
 
 # Max memory to allocate to Java
-forrest.maxmemory=128m
+forrest.maxmemory=256m
 
 # Any other arguments to pass to the JVM. For example, to run on an X-less
 # server, set to -Djava.awt.headless=true

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml Sun Jan 27 18:04:36 2008
@@ -38,7 +38,8 @@
  <p>
         This document will guide you through the very first steps of setting up a project with OJB. To
         make this easier, OJB comes with a blank project template called ojb-blank which you're
-        encouraged to use. You can download it <a href="ext:ojb/binaries-version">here</a>.
+        encouraged to use (by direct download or build by source distribution).
+            You can download it <a href="ext:ojb/binaries-version">here</a>.
      </p>
      <p>
         For the purpose of this guide, we'll be showing you how to setup the project for a
@@ -64,7 +65,7 @@
             <p>
                 The ojb-blank project contains all libraries necessary to get running. However, there may
                 be additional libraries required when you venture deeper into OJB's APIs. See
-                <a href="site:deployment/additional-jars">here</a> for a list of additional libraries.<br/>
+                <a href="site:dependencies">here</a> for a list of additional libraries.<br/>
                 Most notably, you'll probably want to add the jdbc driver for you database unless you
                 plan to use the embedded <a href="ext:sourceforge/hsqldb">Hsqldb database</a> for which the
                 ojb-blank project is pre-configured (including all necessary jars).

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/advanced-technique.xml Sun Jan 27 18:04:36 2008
@@ -1216,65 +1216,98 @@
 
         <anchor id="persistent-field"/>
         <section>
-            <title>Change PersistentField Class</title>
+            <title>Strategies to persist fields - <code>PersistentField</code> class</title>
             <p>
                 OJB supports a pluggable strategy to read and set the persistent
                 attributes in the persistence capable classes. All strategy implementation
                 classes have to implement the interface
                 <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentField</code>. OJB provide
-                a few implementation classes which can be set in
-                <a href="ext:ojb/ojb.properties">OJB.properties</a> file:
-            </p>
-            <source><![CDATA[
-# The PersistentFieldClass property defines the implementation class
-# for PersistentField attributes used in the OJB MetaData layer.
-# By default the best performing attribute/refection based implementation
-# is selected (PersistentFieldDirectAccessImpl).
-#
-# - PersistentFieldDirectImpl
-#   is a high-speed version of the access strategies.
-#   It does not cooperate with an AccessController,
-#   but accesses the fields directly. Persistent
-#   attributes don't need getters and setters
-#   and don't have to be declared public or protected
-# - PersistentFieldCGLibImpl
-#   A very fast beans compliant (getter/setter access based) PersistentField
-#   implementation (it's three times faster than the direct field access via reflection).
-#   Needs public getter/setter for all declared fields.
-# - PersistentFieldPrivilegedImpl
-#   Same as above, but does cooperate with AccessController and do not
-#   suppress the java language access check (but is slow compared with direct access).
-# - PersistentFieldIntrospectorImpl
-#   uses JavaBeans compliant calls only to access persistent attributes.
-#   No Reflection is needed. But for each attribute xxx there must be
-#   public getXxx() and setXxx() methods.
-# - PersistentFieldDynaBeanAccessImpl
-#   implementation used to access a property from a
-#   org.apache.commons.beanutils.DynaBean.
-# - PersistentFieldAutoProxyImpl
-#   for each field determines upon first access how to access this particular field
-#   (cglib based, directly, as a bean, as a dyna bean) and then uses that strategy.
-#   The order of field access testing goes from the fastest to slowest, so you will always
-#   get the best performance.
-#
-PersistentFieldClass=org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldDirectImpl
-#PersistentFieldClass=org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldCGLibImpl
-#PersistentFieldClass=org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldPrivilegedImpl
-#PersistentFieldClass=org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldIntrospectorImpl
-#PersistentFieldClass=org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldDynaBeanImpl
-#PersistentFieldClass=org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldAutoProxyImpl
-#(DynaBean implementation does not support nested fields)
-#]]></source>
-            <p>
-                E.g. if the <code>PersistentFieldDirectImpl</code> is used there must be an attribute in the
-                persistent class with this name, if the <code>PersistentFieldCGLibImpl</code> is used there must
-                be a <em>JavaBeans</em> compliant property of this name.
-                <br/>
-                More info about the individual implementation can be found in <a href="ext:javadoc">javadoc</a>.
+                a <a href="#persistent-field-impl">few implementation classes (see below)</a> which can be set
             </p>
+            <ul>
+                <li>
+                    global in the <a href="ext:ojb/ojb.properties">OJB.properties</a> file. Defines the
+                    global used <code>PersistentField</code> implementation used as default in all mapped
+                    classes.
+
+                </li>
+                <li>
+                    per class in the <a href="site:repository/class-descriptor">class-descriptor</a> using the
+                    <em>field-class</em> attribute. Overrides the
+                    global setting for all fields of the current class.
+                </li>
+                <li>
+                    per field in the <a href="site:repository/field-descriptor">field-descriptor</a> using the
+                    <em>field-class</em> attribute. Overrides the
+                    global and per class settings for the current field.
+                </li>
+            </ul>
+
+
+            <anchor id="persistent-field-impl"/>
+            <section>
+                <title><code>PersistentField</code> Implementations</title>
+                <p>
+                    All implementations support OJB's
+                    <a href="site:basic-technique/shortcut-name">shortcut name feature</a>.
+                    The <code>PersistentField</code> implementations shipped with OJB:
+                </p>
+                <ul>
+                    <li>
+                        <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldAutoProxyImpl</code><br/>
+                        for each field determines upon first access how to access this particular field
+                        (cglib based, directly, as a bean, as a dyna bean) and then uses that strategy. The order
+                        of field access testing goes from the fastest to slowest, so you will always get the
+                        best performance.
+                        <br/>
+                        Shortcut name: <em>auto</em>
+                    </li>
+                    <li>
+                        <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldDirectImpl</code><br/>
+                        is a high-speed version of the access strategies. It does not cooperate with an
+                        <code>AccessController</code>, but accesses the fields directly. Persistent attributes
+                        don't need getters and setters and don't have to be declared <em>public</em> or
+                        <em>protected</em>.
+                        <br/>
+                        Shortcut name: <em>direct</em>
+                    </li>
+                    <li>
+                        <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldCGLibImpl</code><br/>
+                        A very fast beans compliant (getter/setter access based) PersistentField implementation
+                        (it's three times faster than the direct field access via reflection - with JDK versions before 1.5).
+                        Needs public getter/setter for all declared fields.
+                        <br/>
+                        Shortcut name: <em>cglib</em>
+                    </li>
+                    <li>
+                        <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldIntrospectorImpl</code><br/>
+                        Uses JavaBeans compliant calls only to access persistent attributes.
+                        But for each attribute xxx there must be public getXxx() and setXxx() methods.
+                        <br/>
+                        Shortcut name: <em>introspector</em>
+                    </li>
+                    <li>
+                        <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldPrivilegedImpl</code><br/>
+                        Similar to the <em>direct access</em> implementation, but does cooperate with
+                        the <code>AccessController</code> and do not suppress the java language access checks
+                         - but is slow compared with <em>direct access</em>.
+                        <br/>
+                        Shortcut name: <em>privileged</em>
+                    </li>
+                    <li>
+                        <code>org.apache.ojb.broker.metadata.fieldaccess.PersistentFieldDynaBeanImpl</code><br/>
+                        implementation used to access a property from a <code>org.apache.commons.beanutils.DynaBean</code>.
+                        <br/>
+                        NOTE: This implementation does not support
+                        <a href="site:advanced-technique/nested-objects">nested fields</a>.
+                        <br/>
+                        Shortcut name: <em>dynabean</em>
+                    </li>
+                </ul>
+            </section>
             <p>
-                Per default, OJB uses a direct access implementation (<code>PersistentFieldDirectImpl</code>)
-                which requires actual fields to be present.
+                By default OJB uses a direct access implementation (<code>PersistentFieldDirectImpl</code>)
+                which only requires actual fields to be present.
             </p>
             <p>
                 If you have bean compliant and non-compilant persistence capable classes the
@@ -1282,8 +1315,50 @@
                 will always use the best performing strategy.
             </p>
             <p>
-                For best performance <code>PersistentFieldCGLibImpl</code> is recommended.
+                If you want to avoid setter/getter for fields only used by OJB, like a
+                <a href="site:advanced-technique/table-per-hierarchy">discriminator field</a> or
+                <a href="site:lock-manager/optimistic-locking">optimistic locking</a> fields, independent
+                from the global used <code>PersistentField</code> implementation, declare
+                the <code>PersistentFieldDirectImpl</code> implementation class on
+                <a href="site:repository/field-descriptor">field-descriptor</a> level via <em>field-class</em>.
             </p>
+            <p>
+                Below you can find an example. Class <code>my.Article</code> declare the bean compliant
+                getter/setter access based <code>PersistentFieldCGLibImpl</code> on class level (override the global
+                setting specified in the <a href="ext:ojb/ojb.properties">OJB.properties</a> file). But for
+                field <em>version</em> the direct field access without getter/setter is specified.
+            </p>
+            <source><![CDATA[
+<class-descriptor
+    class="my.Article"
+    table="ARTICLE_"
+    field-class="cglib"
+   >
+      <field-descriptor
+         name="id"
+         column="ID"
+         jdbc-type="INTEGER"
+         primarykey="true"
+         autoincrement="true"
+      />
+      <field-descriptor
+         name="name"
+         column="NAME_"
+         jdbc-type="VARCHAR"
+      />
+      <field-descriptor
+         name="version"
+         column="VERSION_"
+         jdbc-type="INTEGER"
+         locking="true"
+         field-class="direct"
+      />
+   </class-descriptor>
+            ]]></source>
+            <note>
+                For best performance <code>PersistentFieldDirectImpl</code> or
+                <code>PersistentFieldCGLibImpl</code> is recommended.
+            </note>
         </section>
 
 

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/basic-technique.xml Sun Jan 27 18:04:36 2008
@@ -1312,10 +1312,10 @@
         <anchor id="delete-orphan"/>
         <section>
             <title>Delete or Unlink of orphan collection objects</title>
-            <p>## TODO: IS NOT UP-TO-DATE ##</p>
+            <p>## TODO: IS NOT UP-TO-DATE ##  </p>
             <p>
                 OJB support several possibilities of handling objects removed from
-                referenced/linked 1:n or m:n collections (so called <em>orphan (collection) objects</em>):
+                referenced/linked 1:n collections - so called <em>orphan (collection) objects</em>:
                 <br/>
                 - Do nothing with the removed object when the main object is stored<br/>
                 - Unlink the removed object when the main object is stored<br/>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml Sun Jan 27 18:04:36 2008
@@ -120,6 +120,9 @@
                         if you plan to use the JDO Api.
                     </dd>
                 </dl>
+                <note>
+                    See here for an <a href="site:dependencies">overview of all dependencies</a>.
+                </note>
             </section>
 
             <anchor id="optional-jars"/>
@@ -180,6 +183,9 @@
                         ignore these files then.
                     </dd>
                 </dl>
+                <note>
+                    See here for an <a href="site:dependencies">overview of all dependencies</a>.
+                </note>
             </section>
 
             <section>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/objectcache.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/objectcache.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/objectcache.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/objectcache.xml Sun Jan 27 18:04:36 2008
@@ -381,8 +381,9 @@
                     only returned from cache if it was not garbage collected and was not timed out.
                 </p>
                 <p>
-                    This implementation supports a specific <a href="site:basic-technique/shortcut-name">shortcut name</a>
-                    '<em>default</em>' as convenience instead of the full qualified class name.
+                    Support OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>
+                    within the <em>object-cache</em> attribute ('<em>default</em>') as convenience instead
+                    of the full qualified class name.
                     <br/>
                     To enable this
                     <code>ObjectCache</code> implementation declare
@@ -517,9 +518,10 @@
                     cache with <a href="#defaultImpl"><code>ObjectCacheDefaultImpl</code></a> as second level cache.
                 </p>
                 <p>
-                    This implementation supports a specific <a href="site:basic-technique/shortcut-name">shortcut name</a>
-                    '<em>twoLevel</em>' as convenience instead of the full qualified class name and shortcut names in the
-                    attributes 'applicationCache' and 'copyStrategy' are supported too.
+                    Support OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>
+                    within the <em>object-cache</em> attribute ('<em>twoLevel</em>') as convenience instead
+                    of the full qualified class name and shortcut names in the attributes '<em>applicationCache</em>' and
+                    '<em>copyStrategy</em>' are supported too.
                 </p>
                 <source><![CDATA[
 <object-cache class="twoLevel">
@@ -536,7 +538,7 @@
 
     <!-- ObjectCacheDefaultImpl attributes -->
     <attribute attribute-name="timeout" attribute-value="900"/>
-    <attribute attribute-name="autoSync" attribute-value="true"/>
+    <attribute attribute-name="autoSync" attribute-value="false"/>
     <attribute attribute-name="cachingKeyType" attribute-value="0"/>
     <attribute attribute-name="useSoftReferences" attribute-value="true"/>
 </object-cache>]]></source>
@@ -668,12 +670,17 @@
                 </p>
                 <p>
                     So, objects modified by other threads will not influence the cached objects, because for each
-                    broker instance the objects will be cached separately and each thread
-                    should use it's own <em>PersistenceBroker</em> instance.
+                    broker instance the objects will be cached separately (if each thread
+                    should use it's own <em>PersistenceBroker</em> instance).
                 </p>
                 <p>
-                    Supports OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>.
+                    Support OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>
+                    within the <em>object-cache</em> attribute (<em>'PerBroker'</em>) and supports <em>'session'</em>
+                    instead of the default shortcut name as additional shortcut name.
                 </p>
+                <source><![CDATA[
+<object-cache class="session">
+</object-cache>]]></source>
             </section>
 
             <anchor id="emptyImpl"/>
@@ -688,8 +695,12 @@
                     of object graphs with circular references will be handled internally by OJB).
                 </note>
                 <p>
-                    Supports OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>.
+                    Support OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>
+                    within the <em>object-cache</em> attribute.
                 </p>
+                <source><![CDATA[
+<object-cache class="empty">
+</object-cache>]]></source>
             </section>
 
 
@@ -702,8 +713,13 @@
                     <a href="ext:jakarta/jcs">turbine-JCS</a>.
                 </p>
                 <p>
-                    Supports OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>.
+                    Support OJB's <a href="site:basic-technique/shortcut-name">shortcut name feature</a>
+                    within the <em>object-cache</em> attribute (<em>'JCS'</em>) and supports <em>'jcs'</em>
+                    instead of the default shortcut name as additional shortcut name.
                 </p>
+                <source><![CDATA[
+<object-cache class="jcs">
+</object-cache>]]></source>
             </section>
 
 

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/pb-guide.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/pb-guide.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/pb-guide.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/pb-guide.xml Sun Jan 27 18:04:36 2008
@@ -321,6 +321,65 @@
 
         </section>
 
+
+        <anchor id="use-odmg"/>
+        <section>
+            <title>Use of the ODMG-API within the PB-API</title>
+            <p>
+                It is possible to use the <a href="site:odmg-guide">ODMG-API</a> for insert, update and delete
+                operations within the PB-api. The ODMG-api offers <em>persistence by reachability</em> and
+                change-tracking of persistence capable objects.
+            </p>
+            <p>
+                Lookup an <code>ImplementationExt</code> instance - it's an extension of ODMG's
+                <code>Implementation</code> class. If only one
+                <a href="site:repository/jdbc-connection-descriptor">database connection access</a>
+                is defined the <code>ImplementationExt</code> instance can be shared by the whole application.
+                <br/>
+                The example below show how to insert (A), update (B) and delete (C) persistence capable objects:
+            </p>
+            <source><![CDATA[
+PersistenceBroker broker = ...
+// Get the ODMG Implementation instance once per database
+ImplementationExt odmg = OJB.getInstance();
+...
+--A--
+// inject the broker instance into the ODMG-api
+Transaction tx = odmg.newTransaction(broker, false);
+// Lookup the current database instance
+Database db = odmg.getDatabase(null);
+tx.begin();
+// explicite persist the object
+db.makePersistent(new Book("test"));
+tx.commit();
+
+--B--
+// inject the broker instance into the ODMG-api
+Transaction tx = odmg.newTransaction(broker, false);
+tx.begin();
+// lock the object
+tx.lock(book, Transaction.WRITE);
+book.setName("Good Omens");
+tx.commit();
+
+--C--
+// inject the broker instance into the ODMG-api
+Transaction tx = odmg.newTransaction(broker, false);
+// Lookup the current database instance
+Database db = odmg.getDatabase(null);
+tx.begin();
+// delete the object
+db.deletePersistent(new Book("test"));
+tx.commit();
+            ]]></source>
+            <p>
+                Create a new odmg-Trasaction instance by using a specific method which allows to inject the current used
+                <code>PersistenceBroker</code> instance. Different from the <em>normal</em> use of the ODMG-api there is
+                no need to open an <code>Database</code> instance. OJB implicite opens a <code>Database</code> instance
+                based on the specified broker instance.
+            </p>
+        </section>
+
     </body>
 </document>
 

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml Sun Jan 27 18:04:36 2008
@@ -493,8 +493,8 @@
                     The following
                     <code>class-descriptor</code> attributes are also supported in the
                     <strong>ojb.class</strong>
-                    tag and will be written directly to the generated class descriptor (see the
-                    <a href="repository.html#class-descriptor">repository.dtd</a> for their meaning):
+                    tag and will be written directly to the generated class-descriptor (see the
+                    <a href="repository.html#class-descriptor">repository docs</a> for their meaning):
                 </p>
                 <ul>
                     <li>
@@ -2114,7 +2114,7 @@
                 </dl>
                 <p>
                     Other supported attributes (see
-                    <a href="repository.html#reference-descriptor">repository.dtd</a> for their
+                    <a href="repository.html#reference-descriptor">repository docs</a> for their
                     meaning) written directly to the repository descriptor file:
                 </p>
                 <ul>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml Sun Jan 27 18:04:36 2008
@@ -38,7 +38,7 @@
 
 <section><title>How to build O/R mapping files</title>
 <p>
- Writing the repository.xml file for only a few classes
+ Writing the <a href="site:repository">repository.xml</a> file for only a few classes
  can easily be done manually with the text or xml editor of your choice.
 </p>
     <p>
@@ -51,7 +51,7 @@
 </p>
 </section>
 
-<section><title>classification of O/R related transformations</title>
+<section><title>Classification of O/R related transformations</title>
 <p>
  Let's start with a classification of the source transformation problems
  that developers have to face in an O/R environment.
@@ -66,12 +66,12 @@
  All modern UML tools can export to the XMI standard format.
  </li>
  <li>
- Other tools, such as Torque, also use a model based approach
- but use different model file formats (typically XML based)
+ Other tools, such as <a href="ext:ddlutils">DdlUtils</a> or <a href="ext:torque">Torque</a>,
+            also use a model based approach but use different model file formats (typically XML based)
  </li>
  <li>
  Java source code for the persistent classes.
- The Java source code can possibly be enhanced with xdoclet tags.
+ The Java source code can possibly be enhanced with <a href="ext:xdoclet">xdoclet</a> tags.
  </li>
  <li>
  The OJB repository.xml file. This file contains all the
@@ -97,21 +97,21 @@
  be generated from this model.
  </li>
  <li>
- <strong>Forward engineering from Torque:</strong> A model of the persistent entity classes exists
- in form of a Torque.XML file.
- Java code, repository.xml and DDL for the database tables have to
+ <strong>Forward engineering from <a href="ext:ddlutils">DdlUtils</a> or <a href="ext:torque">Torque</a>:</strong>
+            A model of the persistent entity classes exists as sources or in form of a Torque.XML file.
+ The repository.xml file, DDL for the database tables (and Java code) have to
  be generated from this model.
  </li>
  <li>
  <strong>Forward engineering from the repository.xml:</strong>
  The OJB repository.xml file is used a model format.
- Java code and DDL for the database tables have to
- be generated from this model.
+ Java code and DDL for the database tables (e.g. in form of a xml-file for use with
+            <a href="ext:ddlutils">DdlUtils</a>) have to be generated from this model.
  </li>
  <li>
  <strong>Xdoclet transformation from Java code:</strong>
  Java code for the persistent classes exists and contains special
- comment tags in the Xdoclet ojb-module format.
+ comment tags in the <a href="site:xdoclet-module">Xdoclet ojb-module format</a>.
  Repository.xml and DDL for the database tables have to
  be generated from the java files via Xdoclet transformation.
  </li>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-spring.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-spring.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-spring.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-use-spring.xml Sun Jan 27 18:04:36 2008
@@ -50,6 +50,11 @@
                 <br/>
                 They are simple to setup and require minimal configuration.
             </p>
+            <note>
+                This howto base on Spring version 1.2. In Spring 2.x OJB-support moved to a separate
+                module, so you have to adapt the following sections. Here you can find the documentation
+                to <a href="ext:spring-ojb-module">setup OJB with Spring 2.0</a>.
+            </note>
 
 
             <anchor id="part-1"/>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-work-with-clustering.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-work-with-clustering.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-work-with-clustering.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-work-with-clustering.xml Sun Jan 27 18:04:36 2008
@@ -181,7 +181,8 @@
                 </note>
                 <ul>
                     <li>Add a database column to your table that is either an INTEGER or a TIMESTAMP</li>
-                    <li>Add the field to your java class, and getter/setter methods (depends on the used
+                    <li>Add the field to your java class and getter/setter methods (getter/setter are not mandatory,
+                        this depends on the used
                         <a href="site:advanced-technique/persistent-field">PersistentField implementation</a>):
                     </li>
                 </ul>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/site.xml?rev=615700&r1=615699&r2=615700&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/site.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/site.xml Sun Jan 27 18:04:36 2008
@@ -46,6 +46,7 @@
         <!-- faq label="FAQ's" href="site:faq" / -->
         <status label="Status" href="status.html"/>
         <release-notes label="Release Notes" href="release-notes.html"/>
+        <dependencies label="Dependencies" href="dependencies.html"/>
         <references label="References" href="references.html"/>
         <wiki label="Wiki" href="ext:ojb/wiki-page"/>
         <mail-lists label="Mailing Lists" href="mail-lists.html"/>
@@ -72,14 +73,17 @@
 
         <all label="Index">
             <linkmap label="Sitemap" href="linkmap.html"/>
-            <!--<whole_site_html label="Site as HTML" href="site.html"/>-->
             <whole_site_pdf label="Site as PDF" href="site.pdf"/>
+            <!--<whole_site_html label="Site as HTML" href="wholesite.html"/>-->
         </all>
     </ojb>
 
     <documentation label="Documentation" href="docu/" tab="documentation">
 
         <index label="Summary" href="index.html"/>
+        <getting-started label="Getting Started" href="getting-started.html">
+            <ojb-blank-build-properties href="#ojb-blank-build-properties"/>
+        </getting-started>
         <faq label="FAQ's" href="faq.html">
             <apis href="#apis"/>
             <optimistic-locking href="#optimisticLocking"/>
@@ -90,11 +94,9 @@
             <api-differences href="#differencesBetweenAPI"/>
             <primitive-null href="#primitiveNull"/>
             <password-needed href="#userPasswordNeeded"/>
+            <trace-sql href="#traceProfileSQL"/>
         </faq>
         <javadoc label="JavaDocs" href="ext:javadoc"/>
-        <getting-started label="Getting Started" href="getting-started.html">
-            <ojb-blank-build-properties href="#ojb-blank-build-properties"/>
-        </getting-started>
 
         <tutorials label="Tutorials" href="tutorials/" tab="tutorials">
             <summary label="Summary" href="summary.html"/>
@@ -475,9 +477,10 @@
 
         <!-- Article links used within OJB -->
         <article>
-            <spring-ojb-part-1 href="http://staff.osuosl.org/~mckerrj/?p=3"/>
-            <spring-ojb-part-2 href="http://staff.osuosl.org/~mckerrj/?p=4"/>
-            <spring-ojb-part-3 href="http://staff.osuosl.org/~mckerrj/?p=8"/>
+            <spring-ojb-module href="https://springmodules.dev.java.net/docs/reference/0.8/html_single/#ojb"/>
+            <spring-ojb-part-1 href="http://wiki.osuosl.org/display/howto/Spring%2C+Struts+and+OJB"/>
+            <spring-ojb-part-2 href="http://wiki.osuosl.org/display/howto/Spring%2C+OJB%2C+and+Struts.+Version+2+with+DAO."/>
+            <spring-ojb-part-3 href="http://wiki.osuosl.org/display/howto/Spring%2C+OJB%2C+and+Struts+Third+Installment.+JNDI+and+Caching"/>
             <springframework-and-ojb href="http://blogs.codepuccino.com/dude/index.php?p=23"/>
         </article>
     </external-refs>



---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Loading...