|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ibatis.abator.api.Abator
This class is the main interface to the Abator for iBATIS code generator. A typical execution of the tool involves these steps:
AbatorConfigurationParser
Constructor Summary | |
Abator(AbatorConfiguration abatorConfiguration,
ShellCallback shellCallback,
java.util.List warnings)
Constructs an Abator object. |
Method Summary | |
void |
generate(ProgressCallback callback)
This is the main method for generating code. |
void |
generate(ProgressCallback callback,
java.util.Set contextIds)
This is the main method for generating code. |
void |
generate(ProgressCallback callback,
java.util.Set contextIds,
java.util.Set fullyQualifiedTableNames)
This is the main method for generating code. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Abator(AbatorConfiguration abatorConfiguration, ShellCallback shellCallback, java.util.List warnings) throws InvalidConfigurationException
abatorConfiguration
- The configuration for this run of AbatorshellCallback
- an instance of a ShellCallback interface. You may specify
null
in which case Abator will use the DefaultShellCallback.warnings
- Any warnings generated during execution will be added to this
list. Warnings do not affect the running of the tool, but they
may affect the results. A typical warning is an unsupported
data type. In that case, the column will be ignored and
generation will continue. Abator will only add Strings to the
list. You may specify null
if you do not
want warnings returned.
InvalidConfigurationException
- if the specified configuration
is invalidMethod Detail |
public void generate(ProgressCallback callback) throws java.sql.SQLException, java.io.IOException, java.lang.InterruptedException
callback
- an instance of the ProgressCallback interface, or null
if you do not require progress information
java.sql.SQLException
java.io.IOException
java.lang.InterruptedException
- if the method is cancelled through the ProgressCallbackpublic void generate(ProgressCallback callback, java.util.Set contextIds) throws java.sql.SQLException, java.io.IOException, java.lang.InterruptedException
callback
- an instance of the ProgressCallback interface, or null
if you do not require progress informationcontextIds
- a set of Strings containing context ids to run. Only the
contexts with an id specified in this list will be run. If the list is
null or empty, than all contexts are run.
InvalidConfigurationException
java.sql.SQLException
java.io.IOException
java.lang.InterruptedException
- if the method is cancelled through the ProgressCallbackpublic void generate(ProgressCallback callback, java.util.Set contextIds, java.util.Set fullyQualifiedTableNames) throws java.sql.SQLException, java.io.IOException, java.lang.InterruptedException
callback
- an instance of the ProgressCallback interface, or null
if you do not require progress informationcontextIds
- a set of Strings containing context ids to run. Only the
contexts with an id specified in this list will be run. If the list is
null or empty, than all contexts are run.fullyQualifiedTableNames
- a set of table names to generate. The elements
of the set must be Strings that exactly match what's specified in the configuration.
For example, if table name = "foo" and schema = "bar", then the fully qualified
table name is "foo.bar".
If the Set is null or empty, then all tables in the configuration will be
used for code generation.
InvalidConfigurationException
java.sql.SQLException
java.io.IOException
java.lang.InterruptedException
- if the method is cancelled through the ProgressCallback
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |