Package org.fastnate.generator.statements

Class ConnectedStatementsWriter

java.lang.Object

org.fastnate.generator.statements.AbstractStatementsWriter

org.fastnate.generator.statements.ConnectedStatementsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, StatementsWriter

public class ConnectedStatementsWriter
extends AbstractStatementsWriter

An implementation of a StatementsWriter which writes the SQL statements directly to a database connection.

Author:

Tobias Liefke

Nested Class Summary

Nested classes/interfaces inherited from class org.fastnate.generator.statements.AbstractStatementsWriter

AbstractStatementsWriter.AbstractTableStatement, AbstractStatementsWriter.InsertStatement, AbstractStatementsWriter.PlainStatement, AbstractStatementsWriter.UpdateStatement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATABASE_DRIVER_KEY	Name of the setting that contains the connection driver class, if the writer create the a connection himself.
static final String	DATABASE_PASSWORD_KEY	Name of the setting that contains the connection password, if the writer create the a connection himself.
static final String	DATABASE_URL_KEY	Name of the setting that contains the connection URL, if the writer create the a connection himself.
static final String	DATABASE_USER_KEY	Name of the setting that contains the connection user, if the writer create the a connection himself.
static final String	LOG_STATEMENTS_KEY	Name of the setting which turns logging of statements on or off.
static final String	MAX_BATCH_SIZE_KEY	Name of the setting which controls the maximum size of generated batches.

Constructor Summary

Constructors

Constructor	Description
ConnectedStatementsWriter(Connection connection, GeneratorContext context)	Creates a new StatementsWriter that writes to a database connection.
ConnectedStatementsWriter(GeneratorContext context)	Creates a new StatementsWriter that writes to a database connection.

Method Summary

Modifier and Type	Method	Description
void	close()
TableStatement	createInsertStatement(GeneratorDialect dialect, GeneratorTable table)	Creates a container for a dedicated "insert into table" statement.
void	flush()	Flushes any open statements.
Connection	getConnection()	The database connection that was used when creating this generator.
long	getStatementsCount()	The count of statements that we have executed up to now.
void	writePlainStatement(GeneratorDialect dialect, String sql)	Writes a plain SQL statement.
void	writeStatement(EntityStatement stmt)	Writes the given statement to a file or database.

Methods inherited from class org.fastnate.generator.statements.AbstractStatementsWriter

createPlainStatement, createUpdateStatement, writeComment, writeSectionSeparator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fastnate.generator.statements.StatementsWriter

truncateTables

Field Details

DATABASE_DRIVER_KEY

public static final String DATABASE_DRIVER_KEY

Name of the setting that contains the connection driver class, if the writer create the a connection himself.

See Also:

• Constant Field Values

DATABASE_URL_KEY

public static final String DATABASE_URL_KEY

Name of the setting that contains the connection URL, if the writer create the a connection himself.

See Also:

• Constant Field Values

DATABASE_USER_KEY

public static final String DATABASE_USER_KEY

Name of the setting that contains the connection user, if the writer create the a connection himself.

See Also:

• Constant Field Values

DATABASE_PASSWORD_KEY

public static final String DATABASE_PASSWORD_KEY

Name of the setting that contains the connection password, if the writer create the a connection himself.

See Also:

• Constant Field Values

MAX_BATCH_SIZE_KEY

public static final String MAX_BATCH_SIZE_KEY

Name of the setting which controls the maximum size of generated batches. If set to something below 2, no batches are used.

See Also:

• Constant Field Values

LOG_STATEMENTS_KEY

public static final String LOG_STATEMENTS_KEY

Name of the setting which turns logging of statements on or off.

See Also:

• Constant Field Values

Constructor Details

ConnectedStatementsWriter

public ConnectedStatementsWriter(Connection connection,
 GeneratorContext context)
                          throws SQLException

Creates a new StatementsWriter that writes to a database connection.

Parameters:

connection - the database connection

context - contains the indices for initialization

Throws:

SQLException - if the connection is invalid

ConnectedStatementsWriter

public ConnectedStatementsWriter(GeneratorContext context)
                          throws SQLException

Creates a new StatementsWriter that writes to a database connection. The database connection is created from the properties in the context.

Parameters:

context - contains the properties and indices for initialization

Throws:

SQLException - if the connection is invalid

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AbstractStatementsWriter

Throws:

IOException

createInsertStatement

public TableStatement createInsertStatement(GeneratorDialect dialect,
 GeneratorTable table)

Description copied from interface: StatementsWriter

Creates a container for a dedicated "insert into table" statement.

Specified by:

createInsertStatement in interface StatementsWriter

Overrides:

createInsertStatement in class AbstractStatementsWriter

Parameters:

dialect - the current database dialect

table - the name of the table

Returns:

the created statement

flush

public void flush()
           throws IOException

Description copied from interface: StatementsWriter

Flushes any open statements.

Specified by:

flush in interface StatementsWriter

Overrides:

flush in class AbstractStatementsWriter

Throws:

IOException - if the target throws an exception

writePlainStatement

public void writePlainStatement(GeneratorDialect dialect,
 String sql)
                         throws IOException

Description copied from interface: StatementsWriter

Writes a plain SQL statement. Shortcut for writeStatement(createPlainStatement(sql), dialect).

Parameters:

dialect - the current database dialect

sql - the content of the SQL statement

Throws:

IOException - if the file or database throws an exception

writeStatement

public void writeStatement(EntityStatement stmt)
                    throws IOException

Description copied from interface: StatementsWriter

Writes the given statement to a file or database.

Parameters:

stmt - contains the values to write

Throws:

IOException - if the file or database throws an exception

getConnection

public Connection getConnection()

The database connection that was used when creating this generator.

getStatementsCount

public long getStatementsCount()

The count of statements that we have executed up to now.