Author: jgbutler
Date: Mon Dec 8 09:17:15 2008
New Revision: 724414
URL: http://svn.apache.org/viewvc?rev=724414&view=rev
Log:
[Ibator] More documentation Updates
Modified:
ibatis/trunk/java/tools/ibator/core/build/version.properties
ibatis/trunk/java/tools/ibator/core/doc/ReleaseNotes.txt
ibatis/trunk/java/tools/ibator/core/htmldoc/afterRunning.html
ibatis/trunk/java/tools/ibator/core/htmldoc/intro.html
ibatis/trunk/java/tools/ibator/core/htmldoc/license.html
ibatis/trunk/java/tools/ibator/core/htmldoc/migratingFromAbator.html
ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html
ibatis/trunk/java/tools/ibator/core/htmldoc/running.html
ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IntrospectedColumn.java
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/config/xml/ParserEntityResolver.java
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/generator/ibatis2/sqlmap/elements/AbstractXmlElementGenerator.java
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/IbatorObjectFactory.java
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/types/JdbcTypeNameTranslator.java
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/plugins/EqualsHashCodePlugin.java
Modified: ibatis/trunk/java/tools/ibator/core/build/version.properties
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/build/version.properties?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/build/version.properties (original)
+++ ibatis/trunk/java/tools/ibator/core/build/version.properties Mon Dec 8
09:17:15 2008
@@ -1,4 +1,4 @@
#ibator build version info
-#Sun Dec 07 20:41:27 CST 2008
+#Mon Dec 08 11:13:44 CST 2008
version=1.2.0
-buildNum=649
+buildNum=651
Modified: ibatis/trunk/java/tools/ibator/core/doc/ReleaseNotes.txt
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/doc/ReleaseNotes.txt?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/doc/ReleaseNotes.txt (original)
+++ ibatis/trunk/java/tools/ibator/core/doc/ReleaseNotes.txt Mon Dec 8
09:17:15 2008
@@ -1,5 +1,5 @@
-------------------------------------------------------------------------------
-Version 1.2.0: Renamed to ibator
+Version 1.2.0: Renamed to Ibator
Bugs:
1. Fixed the JavaTypeResolver so that an unsupported data type can be
@@ -9,19 +9,17 @@
Enhancements:
1. Ibator now includes a plugin machanism that you can use to extend or
- modify code generated by ibator. In most cases, you should be able
+ modify code generated by Ibator. In most cases, you should be able
to write plugins to replace any custom classes that subclass one of
ibator's built-in generators. Plugins are now the preferred method for
- extending ibator and we recommend that you do not extend ibator's
+ extending Ibator and we recommend that you do not extend Ibator's
built in generators unless absolutely necessary.
-2. Major refactoring of ibator internals. This has changed
- the interface for overriding any of the supplied ibator generators.
+2. Major refactoring of Ibator internals. This has changed
+ the interface for overriding any of the supplied Ibator generators.
3. Added support for runtimeCatalog and runtimeSchema properties to the
table configuration. Thanks to Dan Turkenkopf for the idea and the
patch!
-4. Added ability to configure an implementation of IntrospectedTable interface.
- This to allow overriding of many default behaviors of ibator.
-5. New method - insertSelective
+4. New method - insertSelective
Changes:
@@ -30,14 +28,10 @@
the <jdbcConnection> element to <ibatorConfiguration>, removed the
rootClasspath property from <javaModelGenerator>
3. Changed API on the JavaTypeResolver interface
-4. Changed API on the SqlMapGenerator interface. If you have previously
extended
- one of ibator's implementations, we suggest you switch to an ibator plugin.
-5. Changed API on the DAOGenerator interface. If you have previously extended
- one of ibator's implementations, we suggest you switch to an ibator plugin.
-6. Removed Legacy generator set
-7. Removed after generation hook methods in favor of the new ibator
+4. Removed Legacy generator set
+5. Removed after generation hook methods in favor of the new ibator
plugin mechanism.
-8. <ibatorContext> elements now require an id
+6. <ibatorContext> elements now require an id
-------------------------------------------------------------------------------
Version 1.1.0:
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/afterRunning.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/afterRunning.html?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/afterRunning.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/afterRunning.html Mon Dec 8
09:17:15 2008
@@ -73,8 +73,12 @@
then the files can be listed in any order with repeated
<code><sqlMap></code>
elements after the <code><transactionManager></code> element.</p>
+<p><b>Version 1.2 New Enhancement</b> With Ibator version 1.2 and later, You
may ask
+Ibator to generate a skeleton SQL Map Configuration file with the
SqlMapConfigPlugin.
+See the <a href="configreference/ibatorPlugin.html"><ibatorPlugin></a>
+page for more information.</p>
<h2>Updating the dao.xml File</h2>
-<p>Note that this step is only required if you generated DAOs for the iBATIS
DAO
+<p><b>Important Note:</b> this step is only required if you generated DAOs for
the iBATIS DAO
framework.</p>
<p>The iBATIS DAO framework is configured by an xml file commonly called
<code>dao.xml</code>. The iBATIS DAO framework uses this file to control the
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/intro.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/intro.html?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/intro.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/intro.html Mon Dec 8 09:17:15
2008
@@ -50,6 +50,7 @@
<li>delete by example (using a dynamic where clause)</li>
<li>select by primary key</li>
<li>select by example (using a dynamic where clause)</li>
+ <li>count by example</li>
</ul>
<p>There are different variations of these statements depending on the
structure of the table (for example, if the table doesn't have a primary
key,
@@ -99,7 +100,7 @@
<h2>About the Name</h2>
<p>"Ibator" is an iBATIS styled version of the noun abator. "Abator" means
"one who
abates a nuisance". This describes the purpose of Ibator - it abates some of
the nuisance
-of creating object and configuration files for iBATIS.</p>
+of creating objects and configuration files for iBATIS.</p>
<p>Ibator was originally named "Abator", but the name was changed as the
result of
a federal trade registration dispute.</p>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/license.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/license.html?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/license.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/license.html Mon Dec 8
09:17:15 2008
@@ -16,7 +16,7 @@
</div>
<h1>Ibator Licensing Information</h1>
-<p>Copyright 2006 The Apache Software Foundation</p>
+<p>Copyright 2006, 2007, 2008 The Apache Software Foundation</p>
<p>Licensed under the Apache License, Version 2.0 (the "License");
you may not use this product except in compliance with the License.
You may obtain a copy of the License at
@@ -32,7 +32,7 @@
</p>
<p>This product includes software developed by the Apache Software
-Foundation <a href="http://www.apache.org";>(http://www.apache.org/)</a>.</p>
+Foundation <a target="_blank"
href="http://www.apache.org";>(http://www.apache.org/)</a>.</p>
<p>This product includes the <code>EqualsUtil</code> and
<code>HashCodeUtil</code> classes
from <a target="_blank"
href="http://www.javapractices.com";>http://www.javapractices.com</a>.</p>
Modified: ibatis/trunk/java/tools/ibator/core/htmldoc/migratingFromAbator.html
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/htmldoc/migratingFromAbator.html?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/migratingFromAbator.html
(original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/migratingFromAbator.html Mon
Dec 8 09:17:15 2008
@@ -16,13 +16,16 @@
</div>
<h1>Migrating from Abator</h1>
-<p>This page details changes to the XML configuration file between
+<p>This page details changes between
Ibator and Abator. For most users, the changes should be simple.
If you extended any of Abator's classes to supply custom implementations
of code generators or the Java type resolver, you will need to rework
those custom classes.</p>
-<p>The following list details the required changes to the XML configuration
-files:</p>
+<p>The changes are listed in three categories: from required
+configuration changes to less common changes. Note that most changes
+are described assuming you are using XML configuration for Ibator. If you
+are using Java based configuration, then the changes are still required
+and should be easy to deduce from the description of the XML changes.</p>
<h2>Required for All Users</h2>
<ul>
<li>The DTD has changed. The new DOCTYPE should be
@@ -86,7 +89,7 @@
simplified. If you specified a custom implementation on the
<code><javaTypeResolver></code> element, you must rework your
implementation
class.</li>
- <li>The <cde>ProgressCallback</code> interface has changed significantly.
If you implemented
+ <li>The <code>ProgressCallback</code> interface has changed significantly.
If you implemented
this interface for some other execution environment, you will need to
rework your implementation.</li>
</ul>
</body>
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=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html
(original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/reference/building.html Mon Dec
8 09:17:15 2008
@@ -30,8 +30,8 @@
(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 requires that ANT_HOME and JAVA_HOME environment
variables be defined.
- If they are not already defined on your system, then
+ <li>The build file ony 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>
<li>Run the Ant build script by running the batch file
<code>../build/build.bat</code>
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=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/running.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/running.html Mon Dec 8
09:17:15 2008
@@ -167,7 +167,7 @@
<tr>
<td>verbose (optional)</td>
<td>If "true", "yes", etc., then Ibator will log progress messages to the
- ant console. The default is "false".</td>
+ ant console (if Ant is running in verbose mode). The default is
"false".</td>
</tr>
</table>
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=724414&r1=724413&r2=724414&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html (original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/whatsNew.html Mon Dec 8
09:17:15 2008
@@ -29,6 +29,8 @@
<ul>
<li>Fixed the JavaTypeResolver so that columns with unsupported data types
may be overridden by configuration.</li>
+ <li>Fixed IBATIS-523 - a bug in the pre-release version of the
EqualsHashCodePlugin</li>
+ <li>Fixed IBATIS-542 - upgrade the build to Ant version 1.7.1</li>
</ul>
<h3>Enhacements</h3>
@@ -48,6 +50,8 @@
change many of the core behaviors of Ibator. See the
<a href="configreference/ibatorContext.html"><ibatorContext></a>
page
for further information.</li>
+ <li>New generated method - insertSelective. This method will allow you to
use
+ column defaults on a table definition on insert</li>
</ul>
<h3>Changes from Abator</h3>
@@ -56,18 +60,18 @@
<ul>
<li>JSE 5.0 or higher is required for Ibator</li>
<li>Ibator does not contain the "legacy" code generators from Abator. You
must
- choose "Java2" or "Java5" as a target JRE - and code generated from
+ choose "Ibatis2Java2" or "Ibatis2Java5" as a target runtime - and code
generated from
Ibator is compatible with iBATIS version 2.2.0 or higher only. If you
are
using an earlier version of iBATIS - upgrade! If you are not able to
upgrade,
then you must continue to use Abator.</li>
- <li>The classloading strategy in Ibator is changed from Abator. In all
cases, we recommend
+ <li>The classloading strategy in Ibator is changed from Abator. In all
cases, we now recommend
specifying the classpath external to Ibator and we further recommend
that you do not use
the <code><classPathEntry></code> element. You may specify
classpath entries
if you feel you must, but those entries will only be used when loading
JDBC drivers
of Java model root classes. If you write a custom extension to Ibator,
or a plugin,
you must specify that classpath entry external to Ibator.</li>
<li>The API for extending Ibator is significantly changed from Abator.
- In most cases, implementations of these interfaces should
+ In most cases, implementations of the old Abator interfaces should
be converted to Ibator plugins.</li>
<li>The <code>afterXXXGenerationHook</code> methods have been removed from
all Ibator supplied implementations of the core interfaces. If you
@@ -75,7 +79,7 @@
then you <em>must</em> migrate your code to an Ibator plugin.</li>
<li>The build has been significantly modified and now includes an Emma based
code coverage report.</li>
- <li>Many changes to the XML configuration file are required. See the
+ <li>Changes to the XML configuration file are required. See the
<a href="migratingFromAbator.html">Migrating from Abator</a> page for
detailed
information</li>
</ul>
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IntrospectedColumn.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IntrospectedColumn.java?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IntrospectedColumn.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IntrospectedColumn.java
Mon Dec 8 09:17:15 2008
@@ -61,9 +61,6 @@
* Constructs a Column definition. This object holds all the
* information about a column that is required to generate
* Java objects and SQL maps;
- *
- * @param tableAlias The specified table alias, or null. This
- * value is used to rename and alias column names for select statements
*/
public IntrospectedColumn() {
super();
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/config/xml/ParserEntityResolver.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/config/xml/ParserEntityResolver.java?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/config/xml/ParserEntityResolver.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/config/xml/ParserEntityResolver.java
Mon Dec 8 09:17:15 2008
@@ -43,7 +43,7 @@
*/
public InputSource resolveEntity(String publicId, String systemId)
throws SAXException, IOException {
- if (XmlConstants.IBATOR_CONFIG_PUBLIC_ID.equals(publicId)) {
+ if
(XmlConstants.IBATOR_CONFIG_PUBLIC_ID.equalsIgnoreCase(publicId)) {
InputStream is = getClass()
.getClassLoader()
.getResourceAsStream(
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/generator/ibatis2/sqlmap/elements/AbstractXmlElementGenerator.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/generator/ibatis2/sqlmap/elements/AbstractXmlElementGenerator.java?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/generator/ibatis2/sqlmap/elements/AbstractXmlElementGenerator.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/generator/ibatis2/sqlmap/elements/AbstractXmlElementGenerator.java
Mon Dec 8 09:17:15 2008
@@ -39,7 +39,7 @@
* This method should return an XmlElement for the select key used to
* automatically generate keys.
*
- * @param columnDefinition
+ * @param introspectedColumn
* the column related to the select key statement
* @param generatedKey
* the generated key for the current table
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/IbatorObjectFactory.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/IbatorObjectFactory.java?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/IbatorObjectFactory.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/IbatorObjectFactory.java
Mon Dec 8 09:17:15 2008
@@ -69,7 +69,7 @@
* supplied classes or interfaces.
*
* @param type
- * @return
+ * @return the Class loaded from the external classloader
* @throws ClassNotFoundException
*/
public static Class<?> externalClassForName(String type) throws
ClassNotFoundException {
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/types/JdbcTypeNameTranslator.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/types/JdbcTypeNameTranslator.java?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/types/JdbcTypeNameTranslator.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/internal/types/JdbcTypeNameTranslator.java
Mon Dec 8 09:17:15 2008
@@ -31,9 +31,11 @@
}
/**
+ * Translates from a java.sql.Types values to the proper iBATIS
+ * string representation of the type.
*
* @param jdbcType a value from java.sql.Types
- * @return
+ * @return the iBATIS String representation of a JDBC type
*/
public static String getJdbcTypeName(int jdbcType) {
String answer;
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/plugins/EqualsHashCodePlugin.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/plugins/EqualsHashCodePlugin.java?rev=724414&r1=724413&r2=724414&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/plugins/EqualsHashCodePlugin.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/plugins/EqualsHashCodePlugin.java
Mon Dec 8 09:17:15 2008
@@ -106,7 +106,7 @@
* </ul>
*
* @param topLevelClass the class to which the method will be added
- * @param columnDefinitions column definitions of this class and
+ * @param introspectedColumns column definitions of this class and
* any superclass of this class
* @param introspectedTable the table corresponding to this class
*/
@@ -200,7 +200,7 @@
* Note that this is a very simplistic implementation of hashCode.
*
* @param topLevelClass the class to which the method will be added
- * @param columnDefinitions column definitions of this class and
+ * @param introspectedColumns column definitions of this class and
* any superclass of this class
* @param introspectedTable the table corresponding to this class
*/
