Running Ibator

Ibator can be run in the following ways:

• From the command line with an XML configuration
• As an Ant task with an XML configuration
• From another Java program with an XML configuration
• From another Java program with a Java based configuration

Each method is described in detail below.

Note: there is also an Eclipse plugin for Ibator that adds extra function - namely good integration into Eclipse, an Eclipse enabled Ant task, and support for automatic merging of Java files. See the Ibator home page for information on installing the Eclipse plugin.

Important: When running outside of an IDE environment like Eclipse, Ibator interprets the targetProject and targetPackage attributes in all XML configurations as follows:

• targetProject is assumed to be an existing directory structure. Ibator will fail if this directory structure does not exist.
• targetPackage will be translated to a suitable subdirectory structure of the targetProject directory structure. Ibator will create these subdirectories if necessary.

Running Ibator from the Command Line

Ibator may be run directly from the command line. The JAR manifest includes the name of the default class (org.apache.ibatis.ibator.api.IbatorRunner) or you may specify it yourself. The IbatorRunner class accepts several arguments as detailed below:

You must create an Ibator XML configuration file to run Ibator from the command line. If the file is named "ibatorConfig.xml", then any of the following command lines will run Ibator:

   java -jar ibator.jar -configfile ibatorConfig.xml
   java -jar ibator.jar -configfile ibatorConfig.xml -overwrite
   java -cp ibator.jar org.apache.ibatis.ibator.api.IbatorRunner -configfile ibatorConfig.xml
   java -cp ibator.jar org.apache.ibatis.ibator.api.IbatorRunner -configfile ibatorConfig.xml -overwrite

Running Ibator from Ant

Ibator includes a simple Ant task. The task must be defined in your build.xml file, and the task has three parameters. Here is an example build.xml file:

   <project default="genfiles" basedir=".">
     <property name="generated.source.dir" value="${basedir}" />

     <target name="genfiles" description="Generate the files">
       <taskdef name="ibator"
                classname="org.apache.ibatis.ibator.ant.IbatorAntTask"
                classpath="ibator.jar" />
       <ibator overwrite="true" configfile="ibatorConfig.xml" verbose="false" >
         <propertyset>
           <propertyref name="generated.source.dir"/>
         </propertyset>
       </ibator>
     </target>
   </project>

Ibator task attributes are as follows:

Notes:

• The classpath on the <taskdef> is used to tell Ant where the Ibator JAR file is. This is optional if you add Ibator to the Ant classpath in one of the other ways described in the Ant manual
• The name of the task can be anything you desire, "ibator" is simply an example
• The task supports an optional nested <propertyset> element which is the standard Ant property set type. This can be used to pass parameters into a configuration file. For example, the above property generated.source.dir can be accessed in the Ibator configuration file with the escape sequence ${generated.source.dir}
• If a property is specified in the configuration file and is not resolved, then the escaped property string will be passed "as is" into the generated code.

Running Ibator from Java with an XML Configuration File

The following code sample shows how to call Ibator from Java. It does not show exception handling, but that should be obvious from the compiler errors :)

   List<String> warnings = new ArrayList<String>();
   boolean overwrite = true;
   File configFile = new File("ibatorConfig.xml");
   IbatorConfigurationParser cp = new IbatorConfigurationParser(warnings);
   IbatorConfiguration config = cp.parseIbatorConfiguration(configFile);
   DefaultShellCallback callback = new DefaultShellCallback(overwrite);
   Ibator ibator = new Ibator(config, callback, warnings);
   ibator.generate(null);

Notes:

• Configuration file properties may be passed to the parser as a parameter on the IbatorConfigurationParser constructor. If not passed explicitly, the JVM system properties will be searched for the value of configuration file properties. For example, the property generated.source.dir can be accessed in the Ibator configuration file with the escape sequence ${generated.source.dir}
• If a property is specified in the configuration file and is not resolved, then the escaped property string will be passed "as is" into the generated code.

Running Ibator from Java with a Java Based Configuration

The following code sample shows how to call Ibator from Java only. It does not show exception handling, but that should be obvious from the compiler errors :)

   List<String> warnings = new ArrayList<String>();
   boolean overwrite = true;
   IbatorConfiguration config = new IbatorConfiguration();

   //   ... fill out the config object as appropriate...

   DefaultShellCallback callback = new DefaultShellCallback(overwrite);
   Ibator ibator = new Ibator(config, callback, warnings);
   ibator.generate(null);