You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ibatis.apache.org by jg...@apache.org on 2009/02/27 00:26:58 UTC
svn commit: r748348 - in /ibatis/trunk/java/tools/ibator/core/htmldoc: ./
configreference/ generatedobjects/ reference/ usage/
Author: jgbutler
Date: Thu Feb 26 23:26:58 2009
New Revision: 748348
URL: http://svn.apache.org/viewvc?rev=748348&view=rev
Log:
[Ibator] Fix minor documentation mistakes
Modified:
ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/columnRenamingRule.html
ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html
ibatis/trunk/java/tools/ibator/core/htmldoc/generatedobjects/extendingExampleClass.html
ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html
ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html
ibatis/trunk/java/tools/ibator/core/htmldoc/running.html
ibatis/trunk/java/tools/ibator/core/htmldoc/usage/oracle.html
ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/columnRenamingRule.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/columnRenamingRule.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/columnRenamingRule.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/columnRenamingRule.html Thu Feb 26 23:26:58 2009
@@ -30,7 +30,7 @@
</ul>
<p>It might be annoying to have the generated properties
all containing the CUST prefix. The prefix can be removed by
- specifying a renamimg rule like this:</p>
+ specifying a renaming rule like this:</p>
<p><code><columnRenamingRule searchString="^CUST_" replaceString="" /></code></p>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html Thu Feb 26 23:26:58 2009
@@ -41,7 +41,7 @@
</tr>
<tr>
<td valign="top"><code>(package).CaseInsensitiveLikePlugin</code></td>
- <td>This plugin adds methods to the Example class (actually to the Criteria innser class)
+ <td>This plugin adds methods to the Example class (actually to the Criteria inner class)
to support case insensitive LIKE searches. This demonstrates adding functionality to
the example classes via a plugin, rather than extending the class.</td>
</tr>
@@ -56,7 +56,7 @@
implementation. A better implementation would rely on the HashCodeUtil
from <a target="_blank" href="http://www.javapractices.com">www.javapractices.com</a>
- but we do not want to introduce another
- dependancy in this simple plugin.</p></td>
+ dependency in this simple plugin.</p></td>
</tr>
<tr>
<td valign="top"><code>(package).RenameExampleClassPlugin</code></td>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/generatedobjects/extendingExampleClass.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/generatedobjects/extendingExampleClass.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/generatedobjects/extendingExampleClass.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/generatedobjects/extendingExampleClass.html Thu Feb 26 23:26:58 2009
@@ -68,11 +68,11 @@
</pre>
<p>Once the basic class is created, adding additional predicates is a matter
-of adding additional methods the the extended <code>Criteria</code> class.</p>
+of adding additional methods to the extended <code>Criteria</code> class.</p>
<h2>Extending vs. Plugging In</h2>
<p>If you find that you are extending the example classes frequently, it might be
-more convenient for you to create an Ibator Plugin to generate the additional
+more convenient for you to create an Ibator plugin to generate the additional
functionality rather than hand coding the extended classes. The example below (under
the heading "Single Parameter Predicates") can also be accomplished with a plugin
as demonstrated by the class
@@ -102,7 +102,7 @@
name search. In MySQL, the predicate should look like this:</p>
<code>SOUNDEX(FIRST_NAME) = SOUNDEX('frod')</code>
<p>This predicate is too complex to use one of the other methods, so it must
-be inserted into the where clause by simple string substitition. Add the following
+be inserted into the where clause by simple string substitution. Add the following
method to the <code>ExtendedCriteria</code> for this functionality:</p>
<pre>
public ExtendedCriteria andFirstNameSoundsLike(String value) {
@@ -126,7 +126,7 @@
<p>This method can be used to add virtually any predicate to a where clause.
However, it is generally better to use parameter substitution if possible because
-the problems of formatting different datatypes properly (most notably
+the problems of formatting different data types properly (most notably
dates, times, and timestamps). Also, there is a chance of SQL
injection issues with this method if you expose a too generic method.
If possible, we suggest using one of the other methods listed below.</p>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html Thu Feb 26 23:26:58 2009
@@ -31,7 +31,7 @@
(You may use any SubVersion client you prefer. We recommend
<a target="_blank" href="http://tortoisesvn.tigris.org/">TortoiseSVN</a>.)
</li>
- <li>The build file ony requires that the JAVA_HOME environment variable be defined.
+ <li>The build file only requires that the JAVA_HOME environment variable be defined.
If it is not already defined on your system, then
modify the file <code>../build/setupCmdLine.bat</code> to specify
the proper values on your machine.</li>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html Thu Feb 26 23:26:58 2009
@@ -94,7 +94,7 @@
<code>org.apache.ibatis.ibator.api.IbatorPluginAdapter</code> class and override
only the specific methods you need in your plugin.</p>
<p>Methods in the plugin interface can be used to modify code generated by Ibator, or
-to add addtional generated code. Examples of things that can be accomplished with
+to add additional generated code. Examples of things that can be accomplished with
plugins are:</p>
<ul>
<li>Add custom annotations to generated methods</li>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/running.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/running.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/running.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/running.html Thu Feb 26 23:26:58 2009
@@ -144,7 +144,7 @@
<tr>
<td>overwrite (optional)</td>
<td>If "true", "yes", etc., then existing Java files will be overwritten if an existing Java
- file if found with the same nae as a generated file. If "false", "no", etc., and a
+ file if found with the same name as a generated file. If "false", "no", etc., and a
Java file already exists with the same name as a generated file, then Ibator
will write the newly generated Java file to the proper directory with a
unique name (e.g. MyClass.java.1, MyClass.java.2, etc.).
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/usage/oracle.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/usage/oracle.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/usage/oracle.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/usage/oracle.html Thu Feb 26 23:26:58 2009
@@ -20,7 +20,7 @@
<p>If you want to generate objects for a table that has a public synonym, you
should actually generate the objects against the real table - and then change the
table name at runtime. Ibator supports this automatically.</p>
-<p>For example, assume there is a public alias "FRED" that points the the
+<p>For example, assume there is a public alias "FRED" that points to the
table "HR.EMPLOYEES". The following table configuration will generate the objects
based on HR.EMPLOYEES, but the runtime SQL will only refer to FRED:</p>
<pre>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html
URL: http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html?rev=748348&r1=748347&r2=748348&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html Thu Feb 26 23:26:58 2009
@@ -103,7 +103,7 @@
<li>A plugin that will generate an SQL Map Config File
(<code>org.apache.ibatis.ibator.plugins.SqlMapConfigPlugin</code>)
</li>
- <li>A plugin that will make generated model classes Serialiable
+ <li>A plugin that will make generated model classes Serializable
(<code>org.apache.ibatis.ibator.plugins.SerializablePlugin</code>)
</li>
<li>A plugin that will add <code>equals</code> and <code>hashCode</code>
@@ -119,7 +119,7 @@
<li>New generated method - insertSelective. This method will allow you to use
column defaults on a table definition on insert</li>
<li>Added the ability to specify a that DAO implementation classes be in a
- seperate package from the DAO interface classes.</li>
+ separate package from the DAO interface classes.</li>
</ul>
<h3>Changes from Abator</h3>