Module org.jooq.codegen

Package org.jooq.codegen

Class GenerationTool

java.lang.Object

org.jooq.codegen.GenerationTool

public class GenerationTool
extends Object

The GenerationTool takes care of generating Java code from a database schema.

It takes its configuration parameters from an XML file passed in either as a JAXB-annotated Configuration object, or from the file system when passed as an argument to main(String[]).

See http://www.jooq.org/xsd/ for the latest XSD specification.

Author:

Lukas Eder

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_TARGET_DIRECTORY
static String	DEFAULT_TARGET_ENCODING
static String	DEFAULT_TARGET_PACKAGENAME

Constructor Summary

Constructors

Constructor	Description
GenerationTool()

Method Summary

Modifier and Type	Method	Description
static long	copyLarge(InputStream input, OutputStream output)	Copy bytes from a large (over 2GB) InputStream to an OutputStream.
static void	generate(String xml)
static void	generate(Configuration configuration)
static Configuration	load(InputStream in)	Load a jOOQ codegen configuration file from an input stream
static void	main(String[] args)
static void	main(Configuration configuration)	Deprecated. - Use generate(Configuration) instead
void	run(Configuration configuration)
void	setClassLoader(ClassLoader loader)	The class loader to use with this generation tool.
void	setConnection(Connection connection)	The JDBC connection to use with this generation tool.
void	setDataSource(DataSource dataSource)	The JDBC data source to use with this generation tool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TARGET_ENCODING

public static final String DEFAULT_TARGET_ENCODING

See Also:

Constant Field Values

DEFAULT_TARGET_DIRECTORY

public static final String DEFAULT_TARGET_DIRECTORY

See Also:

Constant Field Values

DEFAULT_TARGET_PACKAGENAME

public static final String DEFAULT_TARGET_PACKAGENAME

See Also:

Constant Field Values

Constructor Detail

GenerationTool

public GenerationTool()

Method Detail

setClassLoader

public void setClassLoader(ClassLoader loader)

The class loader to use with this generation tool.

If set, all classes are loaded with this class loader

setConnection

public void setConnection(Connection connection)

The JDBC connection to use with this generation tool.

If set, the configuration XML's <jdbc/> configuration is ignored, and this connection is used for meta data inspection, instead.

setDataSource

public void setDataSource(DataSource dataSource)

The JDBC data source to use with this generation tool.

If set, the configuration XML's <jdbc/> configuration is ignored, and this connection is used for meta data inspection, instead.

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

main

@Deprecated
public static void main(Configuration configuration)
                 throws Exception

Deprecated.

- Use generate(Configuration) instead

Throws:

Exception

generate

public static void generate(String xml)
                     throws Exception

Throws:

Exception

generate

public static void generate(Configuration configuration)
                     throws Exception

Throws:

Exception

run

public void run(Configuration configuration)
         throws Exception

Throws:

Exception

copyLarge

public static long copyLarge(InputStream input,
                             OutputStream output)
                      throws IOException

Copy bytes from a large (over 2GB) InputStream to an OutputStream.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters:

input - the InputStream to read from

output - the OutputStream to write to

Returns:

the number of bytes copied

Throws:

NullPointerException - if the input or output is null

IOException - if an I/O error occurs

Since:

Commons IO 1.3

load

public static Configuration load(InputStream in)
                          throws IOException

Load a jOOQ codegen configuration file from an input stream

Throws:

IOException