Author: jgbutler
Date: Sun Apr 27 20:34:11 2008
New Revision: 652050
URL: http://svn.apache.org/viewvc?rev=652050&view=rev
Log:
ibator: more documentation for plugins
Modified:
ibatis/trunk/java/tools/ibator/core/build/version.properties
ibatis/trunk/java/tools/ibator/core/doc/todo.txt
ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html
ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IbatorPlugin.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=652050&r1=652049&r2=652050&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/build/version.properties (original)
+++ ibatis/trunk/java/tools/ibator/core/build/version.properties Sun Apr 27
20:34:11 2008
@@ -1,4 +1,4 @@
#ibator build version info
-#Thu Apr 24 14:30:52 CDT 2008
+#Sun Apr 27 22:28:35 CDT 2008
version=1.2.0
-buildNum=495
+buildNum=496
Modified: ibatis/trunk/java/tools/ibator/core/doc/todo.txt
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/doc/todo.txt?rev=652050&r1=652049&r2=652050&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/doc/todo.txt (original)
+++ ibatis/trunk/java/tools/ibator/core/doc/todo.txt Sun Apr 27 20:34:11 2008
@@ -1,20 +1,16 @@
Core:
- 1.2
-
- 1. Write page explaining how to use the GENERIC DAOs
- 2. Finish JavaDoc on the IbatorPlugin interface
- 3. Document plugins - plugin lifecycle
-
Future
- 1. Change the base API to allow specifying a connection at
+ 1. Write page explaining how to use the GENERIC DAOs
+
+ 2. Change the base API to allow specifying a connection at
runtime, rather than requiring a connection in the
XML config.
- 2. Refactoring: Make a class for each type of method to be generated
+ 3. Refactoring: Make a class for each type of method to be generated
- 3. Relationships?
+ 4. Relationships?
Eclipse:
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=652050&r1=652049&r2=652050&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html
(original)
+++
ibatis/trunk/java/tools/ibator/core/htmldoc/configreference/ibatorPlugin.html
Sun Apr 27 20:34:11 2008
@@ -16,7 +16,9 @@
<h1>The <ibatorPlugin> Element</h1>
<p>The <ibatorPlugin> element is used to define a plugin. Plugins can
be used
to extend or modify the code generated by ibator. This element is a child
element of the
-<a href="ibatorContext.html"><ibatorContext></a> element.</p>
+<a href="ibatorContext.html"><ibatorContext></a> element. Any number of
+plugins may be specified in a context. The plugins will be called in
+the order that are listed in the configuration.</p>
<p>For more information about plugins, see the
<a href="../reference/pluggingIn.html">Implementing Ibator Plugins</a>
reference
@@ -69,9 +71,9 @@
<li><tt>targetProject</tt> (required) the name of the project where
the
file should be placed.</li>
</ul>
- <p>Note: targetPackage and targetProject follow the same rules as the
- targetPackage and targetProject values on the sqlMapGenerator
- configuration element.</p></td>
+ <p>Note: <code>targetPackage</code> and <code>targetProject</code>
follow
+ the same rules as the <code>targetPackage</code> and
<code>targetProject</code>
+ values on the sqlMapGenerator configuration element.</p></td>
</tr>
</table>
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=652050&r1=652049&r2=652050&view=diff
==============================================================================
--- ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html
(original)
+++ ibatis/trunk/java/tools/ibator/core/htmldoc/reference/pluggingIn.html Sun
Apr 27 20:34:11 2008
@@ -14,21 +14,90 @@
</font>
</p>
<h1>Implementing Ibator Plugins</h1>
+<p>Ibator plugins can be used to modify or add to the objects that are
generated by ibator.
+Plugins must implement the interface
+<code>org.apache.ibatis.ibator.api.IbatorPlugin</code>. The plugin interface
contains many
+methods that ibator calls in different phases of the code generation process.
Implementing the
+entire interface is generally not needed for any particular plugin.
Therefore, most plugins should extend
+the adapter class
<code>org.apache.ibatis.ibator.api.IbatorPluginAdapter</code>. The adapter
+class provides basic plugin support, and implements no-operation methods for
most of the
+interface methods (similar to Swing adapter classes).</p>
-<table border="1" cellspacing="0" cellpadding="5">
- <tr>
- <th>generatorSet</th>
- <th>Implementation Class</th>
- </tr>
- <tr>
- <td>Java2 (the default value)</td>
-
<td><code>org.apache.ibatis.ibator.internal.java.model.JavaModelGeneratorJava2Impl</code></td>
- </tr>
- <tr>
- <td>Java5</td>
-
<td><code>org.apache.ibatis.ibator.internal.java.model.JavaModelGeneratorJava5Impl</code></td>
- </tr>
-</table>
+<h2>Plugin Lifecycle</h2>
+<p>Plugins have a lifecycle. Plugins are created during the initialization of
the code
+generation process and are called, in order, in different phases of the
process. The following
+list shows the basic lifecycle of a plugin:</p>
+<ol type="1">
+ <li>Plugin created through the default constructor</li>
+ <li><code>setIbatorContext</code> method called</li>
+ <li><code>setProperties</code> method called</li>
+ <li><code>validate</code> method called. If this method returns
<code>false</code>,
+ then no further methods in the plugin will be called</li>
+ <li>For each table in the configuration:
+ <ol type="a">
+ <li>DAO Methods:<sup>1,2</sup>
+ <ol type="i">
+ <li><code>daoXXXMethodGenerated(Method, TopLevelClass,
IntrospectedTable)</code> - these methods
+ are called as each method of the DAO implementation is
generated.</li>
+ <li><code>daoImplementationGenerated(TopLevelClass,
IntrospectedTable)</code> method called</li>
+ <li><code>daoXXXMethodGenerated(Method, Interface,
IntrospectedTable)</code> - these methods
+ are called as each method of the DAO interface is generated.</li>
+ <li><code>daoImplementationGenerated(Interface,
IntrospectedTable)</code> method called</li>
+ </ol>
+ </li>
+ <li>Model Methods:<sup>1</sup>
+ <ol type="i">
+ <li><code>modelExampleClassGenerated(TopLevelClass,
IntrospectedTable)</code></li>
+ <li><code>modelPrimaryKeyClassGenerated(TopLevelClass,
IntrospectedTable)</code></li>
+ <li><code>modelBaseRecordClassGenerated(TopLevelClass,
IntrospectedTable)</code></li>
+ <li><code>modelRecordWithBLOBsClassGenerated(TopLevelClass,
IntrospectedTable)</code></li>
+ </ol>
+ </li>
+ <li>SQL Map Methods:<sup>1</sup>
+ <ol type="i">
+ <li><code>sqlMapXXXElementGenerated(XmlElement,
IntrospectedTable)</code> - these methods
+ are called as each element of the SQL map is generated</li>
+ <li><code>sqlMapDocumentGenerated(Document,
IntrospectedTable)</code></li>
+ <li><code>sqlMapDocument(GeneratedXmlFile,
IntrospectedTable)</code></li>
+ </ol>
+ </li>
+ <li><code>contextGenerateAdditionalJavaFiles(IntrospectedTable)</code>
method called</li>
+ <li><code>contextGenerateAdditionalXmlFiles(IntrospectedTable)</code>
method called</li>
+ </ol>
+ </li>
+ <li><code>contextGenerateAdditionalJavaFiles()</code> method called</li>
+ <li><code>contextGenerateAdditionalXmlFiles()</code> method called</li>
+</ol>
+<p><b>Notes:</b><br/>
+<sup>1</sup> - These methods will be called by the ibator supplied code
generators. If you supply
+ a custom code generator, then these methods will only be called if the custom
code generator
+ calls them.<br/>
+<sup>2</sup> - The DAO methods will only be called is a DAO generator is
configured.
+</p>
+
+<h2>Coding Plugins</h2>
+<p>The best way to implement a plugin is to extend the
+<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
+plugins are:</p>
+<ul>
+ <li>Add custom annotations to generated methods</li>
+ <li>Add additional methods to a generated class</li>
+ <li>Add additional elements to a generated XML file</li>
+ <li>Generate additional Java files</li>
+ <li>Generate additional XML files</li>
+</ul>
+
+<p>The <code>contextXXX</code> methods will always be called. Other methods
are called
+by the ibator supplied code generators - and only if the rules for a table
would
+cause the generation of a particular element. For example, the
+<code>modelPrimaryKeyClassGenerated(TopLevelClass, IntrospectedTable)</code>
+method will not be called if the table does not have a primary key.</p>
+
+<p>If you have an idea for a plugin, feel free to ask a question about it on
+the iBATIS Java user list. We're here to help!</p>
</body>
</html>
Modified:
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IbatorPlugin.java
URL:
http://svn.apache.org/viewvc/ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IbatorPlugin.java?rev=652050&r1=652049&r2=652050&view=diff
==============================================================================
---
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IbatorPlugin.java
(original)
+++
ibatis/trunk/java/tools/ibator/core/src/org/apache/ibatis/ibator/api/IbatorPlugin.java
Sun Apr 27 20:34:11 2008
@@ -55,7 +55,8 @@
* <p>
* Plugins are called, and initialized, in the same order they are specified
* in the configuration.
- * <p>The daoXXX, modelXXX, and sqlMapXXX methods are called by the code
+ * <p>
+ * The daoXXX, modelXXX, and sqlMapXXX methods are called by the code
* generators supplied with ibator. If you replace ibator's default code
* generators with other implementations, these methods may not be called.
*
@@ -139,33 +140,364 @@
*/
List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable
introspectedTable);
+ /**
+ * This method is called when the entire DAO interface has been generated.
+ * Implement this method to add additional methods or fields to a generated
+ * DAO interface.
+ *
+ * @param interfaze the generated interface
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoInterfaceGenerated(Interface interfaze, IntrospectedTable
introspectedTable);
+
+ /**
+ * This method is called when the entire DAO implementation has been
generated.
+ * Implement this method to add additional methods or fields to a generated
+ * DAO implementation.
+ *
+ * @param topLevelClass the generated implementation class
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoImplementationGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the countByExample method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated countByExample method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoCountByExampleMethodGenerated(Method method, TopLevelClass
topLevelClass, IntrospectedTable introspectedTable);
- void daoCountByExampleMethodGenerated(Method method, Interface interfaze,
IntrospectedTable introspectedTable);
- void daoDeleteByExampleMethodGenerated(Method method, Interface interfaze,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the deleteByExample method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated deleteByExample method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoDeleteByExampleMethodGenerated(Method method, TopLevelClass
topLevelClass, IntrospectedTable introspectedTable);
- void daoDeleteByPrimaryKeyMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the deleteByPrimaryKey method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated deleteByPrimaryKey method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoDeleteByPrimaryKeyMethodGenerated(Method method, TopLevelClass
topLevelClass, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the insert method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated insert method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoInsertMethodGenerated(Method method, TopLevelClass topLevelClass,
IntrospectedTable introspectedTable);
- void daoInsertMethodGenerated(Method method, Interface interfaze,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByExampleWithBLOBs method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated selectByExampleWithBLOBs method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoSelectByExampleWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoSelectByExampleWithBLOBsMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByExampleWithoutBLOBs method has
been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated selectByExampleWithoutBLOBs method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoSelectByExampleWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoSelectByExampleWithoutBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByPrimaryKey method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated selectByPrimaryKey method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoSelectByPrimaryKeyMethodGenerated(Method method, TopLevelClass
topLevelClass, IntrospectedTable introspectedTable);
- void daoSelectByPrimaryKeyMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleSelective method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated updateByExampleSelective method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByExampleSelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoUpdateByExampleSelectiveMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleWithBLOBs method has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated updateByExampleWithBLOBs method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByExampleWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoUpdateByExampleWithBLOBsMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleWithoutBLOBs method has
been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated updateByExampleWithoutBLOBs method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeySelective method has
been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated updateByPrimaryKeySelective method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeyWithBLOBs method has
been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated updateByPrimaryKeyWithBLOBs method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
- void daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeyWithoutBLOBs method
has been
+ * generated in the DAO implementation class.
+ *
+ * @param method the generated updateByPrimaryKeyWithBLOBs method
+ * @param topLevelClass the partially implemented DAO implementation
+ * class. You can add additional imported classes to the
+ * implementation class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the countByExample method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated countByExample method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoCountByExampleMethodGenerated(Method method, Interface interfaze,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the deleteByExample method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated deleteByExample method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoDeleteByExampleMethodGenerated(Method method, Interface interfaze,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the deleteByPrimaryKey method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated deleteByPrimaryKey method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoDeleteByPrimaryKeyMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the insert method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated insert method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoInsertMethodGenerated(Method method, Interface interfaze,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByExampleWithBLOBs method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated selectByExampleWithBLOBs method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoSelectByExampleWithBLOBsMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByExampleWithoutBLOBs method has
been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated selectByExampleWithoutBLOBs method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoSelectByExampleWithoutBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByPrimaryKey method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated selectByPrimaryKey method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoSelectByPrimaryKeyMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleSelective method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated updateByExampleSelective method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoUpdateByExampleSelectiveMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleWithBLOBs method has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated updateByExampleWithBLOBs method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoUpdateByExampleWithBLOBsMethodGenerated(Method method, Interface
interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleWithoutBLOBs method has
been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated updateByExampleWithoutBLOBs method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeySelective method has
been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated updateByPrimaryKeySelective method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeyWithBLOBs method has
been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated updateByPrimaryKeyWithBLOBs method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
+ void daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeyWithoutBLOBs method
has been
+ * generated in the DAO interface class.
+ *
+ * @param method the generated updateByPrimaryKeyWithoutBLOBs method
+ * @param interfaze the partially implemented DAO interface
+ * class. You can add additional imported classes to the
+ * interface class if necessary.
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
Interface interfaze, IntrospectedTable introspectedTable);
/**
@@ -227,24 +559,171 @@
* about the table as introspected from the database
*/
void modelExampleClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable);
-
-
+
+ /**
+ * This method is called when the SqlMap file has been generated.
+ *
+ * @param sqlMap the generated file (containing the file name,
+ * package name, and project name)
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapGenerated(GeneratedXmlFile sqlMap, IntrospectedTable
introspectedTable);
+
+ /**
+ * This method is called when the SqlMap document has been generated.
+ * This method can be used to add additional XML elements the the
+ * generated document.
+ *
+ * @param document the generated document (note that this is ibator's
+ * internal Document class - not the w3c XML Document class)
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapDocumentGenerated(Document document, IntrospectedTable
introspectedTable);
+
+ /**
+ * This method is called when the base resultMap is generated.
+ *
+ * @param element the generated <resultMap> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapBaseResultMapGenerated(XmlElement element, IntrospectedTable
introspectedTable);
+
+ /**
+ * This method is called when the countByExample element is generated.
+ *
+ * @param element the generated <select> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapCountByExampleElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the deleteByExample element is generated.
+ *
+ * @param element the generated <delete> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapDeleteByExampleElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the deleteByPrimaryKey element is generated.
+ *
+ * @param element the generated <delete> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the exampleWhereClause element is generated.
+ *
+ * @param element the generated <sql> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapExampleWhereClauseGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the insert element is generated.
+ *
+ * @param element the generated <insert> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapInsertElementGenerated(XmlElement element, IntrospectedTable
introspectedTable);
+
+ /**
+ * This method is called when the resultMap with BLOBs element is
+ * generated - this resultMap will extend the base resultMap.
+ *
+ * @param element the generated <resultMap> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapResultMapWithBLOBsGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByPrimaryKey element is generated.
+ *
+ * @param element the generated <select> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByExample element is generated.
+ *
+ * @param element the generated <select> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapSelectByExampleElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the selectByExampleWithBLOBs element is
generated.
+ *
+ * @param element the generated <select> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleSelective element is
generated.
+ *
+ * @param element the generated <update> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleWithBLOBs element is
generated.
+ *
+ * @param element the generated <update> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByExampleWithourBLOBs element is
generated.
+ *
+ * @param element the generated <update> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeySelective element is
generated.
+ *
+ * @param element the generated <update> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeyWithBLOBs element is
generated.
+ *
+ * @param element the generated <update> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable);
+
+ /**
+ * This method is called when the updateByPrimaryKeyWithoutBLOBs element
is generated.
+ *
+ * @param element the generated <update> element
+ * @param introspectedTable ibator's class containing information
+ * about the table as introspected from the database
+ */
void sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement
element, IntrospectedTable introspectedTable);
}
