Author: jgbutler Date: Sat Nov 17 17:40:27 2007 New Revision: 596035 URL: http://svn.apache.org/viewvc?rev=596035&view=rev Log: Abator: Documentation for updateByExample
Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/doc/ReleaseNotes.txt ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/configreference/table.html ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javadao.html ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javamodel.html ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/whatsNew.html Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/doc/ReleaseNotes.txt URL: http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/doc/ReleaseNotes.txt?rev=596035&r1=596034&r2=596035&view=diff ============================================================================== --- ibatis/trunk/java/mapper/mapper2/tools/abator/core/doc/ReleaseNotes.txt (original) +++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/doc/ReleaseNotes.txt Sat Nov 17 17:40:27 2007 @@ -36,7 +36,8 @@ command line and the Ant task 12. IBATIS-414 - make the Example and Criteria classes extendable 13. Added countByExample generated method -14. Java2 is now the default generator set +14. Added updateByExample generated method +15. Java2 is now the default generator set ------------------------------------------------------------------------------- Version 1.0.0: Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/configreference/table.html URL: http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/configreference/table.html?rev=596035&r1=596034&r2=596035&view=diff ============================================================================== --- ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/configreference/table.html (original) +++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/configreference/table.html Sat Nov 17 17:40:27 2007 @@ -150,6 +150,23 @@ <p>The default is <i>true</i>.</p></td> </tr> <tr> + <td valign="top">enableCountByExample</td> + <td>Signifies whether a count by example statement should be generated. + This statement will return the number of rows in a table that match + an example. + <p>The default is <i>true</i>.</p></td> + </tr> + <tr> + <td valign="top">enableUpdateByExample</td> + <td>Signifies whether an update by example statement should be generated. + This statement will update rows in a table that match + an example. This method is not available in the legacy generator set. + If true, an update by example "selective" statement will also be generated. + The "selective" statement will only update columns where the corresponding + value in the record parameter is non-null. + <p>The default is <i>true</i>.</p></td> + </tr> + <tr> <td valign="top">selectByPrimaryKeyQueryId</td> <td>This value will be added to the select list of the select by primary key statement in this form: "'<value>' as QUERYID". @@ -164,13 +181,6 @@ This can be useful for identifying queries in DBA tracing tools at run time. If you use thus value, you should specify a unique id for every different query generated by Abator.</td> - </tr> - <tr> - <td valign="top">enableCountByExample</td> - <td>Signifies whether a count by example statement should be generated. - This statement will return the number of rows in a table that match - an example. - <p>The default is <i>true</i>.</p></td> </tr> <tr> <td valign="top">modelType</td> Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javadao.html URL: http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javadao.html?rev=596035&r1=596034&r2=596035&view=diff ============================================================================== --- ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javadao.html (original) +++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javadao.html Sat Nov 17 17:40:27 2007 @@ -46,6 +46,8 @@ <li>selectByExampleWithBLOBs</li> <li>updateByPrimaryKey (with an override to specify whether or not to update BLOB columns)</li> <li>updateByPrimaryKeySelective (will only update non-null fields in the parameter class)</li> + <li>updateByExample (with an override to specify whether or not to update BLOB columns)</li> + <li>updateByExampleSelective (will only update non-null fields in the parameter class)</li> </ul> <p>Abator attempts to make it easier to deal with tables that contain BLOBs by generating different objects and methods so that you can use the BLOB fields, or ignore them, depending Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javamodel.html URL: http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javamodel.html?rev=596035&r1=596034&r2=596035&view=diff ============================================================================== --- ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javamodel.html (original) +++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/generatedobjects/javamodel.html Sat Nov 17 17:40:27 2007 @@ -102,6 +102,8 @@ <li><code>selectByExample</code></li> <li><code>selectByExampleWithBLOBs</code></li> <li><code>deleteByExample</code></li> + <li><code>countByExample</code></li> + <li><code>updateByExample</code></li> </ul> <p>This class may or may not extend one of the other generated domain classes based on the @@ -113,7 +115,7 @@ <code>«domainObjectName»Example</code> if the <code>domainObjectName</code> attribute is specified on the <code><table></code> configuration element.</p> -<p>This class will be generated if the <code>selectByExample</code> or <code>deleteByExample</code> +<p>This class will be generated if any of the <code>*ByExample</code> methods are enabled. Note that the configuration elements produced by these options can grow quite large. With the "Legacy" generator set, the generated XML will have a very large SQL fragment related to this capability, and the generated DAO class will have many Modified: ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/whatsNew.html URL: http://svn.apache.org/viewvc/ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/whatsNew.html?rev=596035&r1=596034&r2=596035&view=diff ============================================================================== --- ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/whatsNew.html (original) +++ ibatis/trunk/java/mapper/mapper2/tools/abator/core/htmldoc/whatsNew.html Sat Nov 17 17:40:27 2007 @@ -13,10 +13,10 @@ <h3>New Generated Methods</h3> <p>Abator will generate these new methods:</p> <dl> - <dt>countByExample</dt> + <dt><b>countByExample</b></dt> <dd>This method will return an integer representing the number of rows in a table that match the given example.</dd> - <dt>updateByExample</dt> + <dt><b>updateByExample</b></dt> <dd>This method will update all rows in a table that match a given example. This method is available in the Java2 and Java5 generator sets only. There is also a "selective" version of the method that only updates certain columns of a table.</dd> @@ -24,9 +24,9 @@ <h3>Miscellaneous Changes</h3> <ul> - <li>Java2 is now the default generator set. The Legacy generator set will be removed in - the next release of Abator.</li> - <li>Fixed a bug that caused the "trimStrings" property to fail</li> + <li>Java2 is now the default generator set. <b>The Legacy generator set will be removed in + the next release of Abator.</b></li> + <li>Fixed a bug that caused the JavaModelGenerator's "trimStrings" property to fail</li> <li>Fixed the XML file merger so that internal entities are preserved</li> <li>Added the ability to specify properties to ignore qualifiers and change runtime table names in the generated SQL for a table. Primary use cases for this