Changeset 6807 for trunk/doc/src/docbook/appendix/incompatible.xml

Timestamp:

Mar 26, 2015, 1:10:52 PM (8 years ago)

Author:

Nicklas Nordborg

Message:

References #1924, #1927 and #1325. Added information about incompatible changes and things to consider when updgrading to BASE 3.5.

File:

• trunk/doc/src/docbook/appendix/incompatible.xml (modified) (1 diff)

trunk/doc/src/docbook/appendix/incompatible.xml

@@ -35 +35 @@
     and backwards compatible.
   </para>
+  
+  <sect1 id="appendix.incompatible.3.5">
+    <title>BASE 3.5 release</title>
+    
+    <bridgehead id="appendix.incompatible.itemlists">Biomaterial lists has been replaced with item lists</bridgehead>
+    <para>
+      The <classname docapi="net.sf.basedb.core">BioMaterialList</classname> 
+      class has been removed and replaced with <classname 
+      docapi="net.sf.basedb.core">ItemList</classname>. The API is similar 
+      but not exactly the same. In most cases only minor changes are required
+      to make existing code work with the new API.
+    </para>
+    
+    <para>
+      Queries that use the <code>BioMaterial.bioMaterialLists</code> association
+      for joining will no longer work. There is no replacement functionality for
+      joining item lists.
+    </para>
+    
+    <para>
+      All classes in the <code>net.sf.basedb.util.biomaterial</code> package has
+      been deprecated. It is recommended that code that uses any of these classes
+      are updated to use classes in <code>net.sf.basedb.util.listable</code> instead.
+      The API is a bit different, but the new implementations typically performs a 
+      lot better so it is worth the work.
+    </para>
+
+    <para>
+      There are several other minor changes in the API that previously worked with
+      the <code>BioMaterialList</code> class that has been removed and replaced
+      with something else.
+    </para>
+    
+  </sect1>
   
   <sect1 id="appendix.incompatible.3.4">