|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mybatis.generator.api.MyBatisGenerator
public class MyBatisGenerator
This class is the main interface to MyBatis generator. A typical execution of the tool involves these steps:
ConfigurationParser
Constructor Summary | |
---|---|
MyBatisGenerator(Configuration configuration,
ShellCallback shellCallback,
List<String> warnings)
Constructs a MyBatisGenerator object. |
Method Summary | |
---|---|
void |
generate(ProgressCallback callback)
This is the main method for generating code. |
void |
generate(ProgressCallback callback,
Set<String> contextIds)
This is the main method for generating code. |
void |
generate(ProgressCallback callback,
Set<String> contextIds,
Set<String> 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 MyBatisGenerator(Configuration configuration, ShellCallback shellCallback, List<String> warnings) throws InvalidConfigurationException
configuration
- The configuration for this invocationshellCallback
- an instance of a ShellCallback interface. You may specify
null
in which case the DefaultShellCallback will
be used.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. 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 SQLException, IOException, InterruptedException
callback
- an instance of the ProgressCallback interface, or
null
if you do not require progress information
SQLException
IOException
InterruptedException
- if the method is canceled through the ProgressCallbackpublic void generate(ProgressCallback callback, Set<String> contextIds) throws SQLException, IOException, 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
SQLException
IOException
InterruptedException
- if the method is canceled through the ProgressCallbackpublic void generate(ProgressCallback callback, Set<String> contextIds, Set<String> fullyQualifiedTableNames) throws SQLException, IOException, 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
SQLException
IOException
InterruptedException
- if the method is canceled through the ProgressCallback
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |