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

Modifier and Type	Class and Description
private static class	ConnectedStatementsWriter.ContextListener
private static class	ConnectedStatementsWriter.PreparedInsertStatement

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 and Description
private Map<GeneratorTable,List<ConnectedStatementsWriter.PreparedInsertStatement>>	availablePreparedStatements All available prepared statements per table.
private int	batchCount The count of statements executed in the current batch.
private boolean	batchSupported Indicates that the database connection supports batch statements.
private boolean	closeConnection Indicates that we should close the connection at the end.
private Connection	connection The database connection that was used when creating this generator.
private GeneratorContext	context The generator context that is attached to this writer.
private ContextModelListener	contextListener The listener for model changes in the context when new classes are discovered.
static String	DATABASE_DRIVER_KEY Name of the setting that contains the connection driver class, if the writer create the a connection himself.
static String	DATABASE_PASSWORD_KEY Name of the setting that contains the connection password, if the writer create the a connection himself.
static String	DATABASE_URL_KEY Name of the setting that contains the connection URL, if the writer create the a connection himself.
static String	DATABASE_USER_KEY Name of the setting that contains the connection user, if the writer create the a connection himself.
private long	lastLogTime The last time that we have written a log message about the count of statements.
private static org.slf4j.Logger	log
static String	LOG_STATEMENTS_KEY Name of the setting which turns logging of statements on or off.
private boolean	logStatements Indicates that we log each statement for debugging purposes.
static String	MAX_BATCH_SIZE_KEY Name of the setting which controls the maximum size of generated batches.
private int	maxBatchSize The maximum count of statements per batch job.
private static long	MILLISECONDS_BETWEEN_LOG_MESSAGES The count of milliseconds to wait, until a log message with the current count of statements is written.
private static int	MINIMUM_JDBC_DRIVER_MAJOR_VERSION The minimum major version of the JDBC API that the driver needs to support.
private static int	MINIMUM_JDBC_DRIVER_MINOR_VERSION The minimum minor version of the JDBC API that the driver needs to support.
private Statement	plainStatement Used to execute all plain SQL statements.
private List<ConnectedStatementsWriter.PreparedInsertStatement>	preparedStatements All prepared statements for the tables.
private long	statementsCount The count of statements that we have executed up to now.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConnectedStatementsWriter(Connection connection, boolean closeConnection, GeneratorContext context)
	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 and Description
private static Connection	buildConnection(GeneratorContext context)
private void	checkUpdate(int updatedRows, String sql)
void	close()
private void	closeBatch()
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.
private void	writePlainStatement(String sql)
void	writeStatement(EntityStatement stmt) Writes the given statement to a file or database.
private void	writeTableStatement(String sql)

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 Detail

log

@Generated(value="lombok")
private static final org.slf4j.Logger log

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

MILLISECONDS_BETWEEN_LOG_MESSAGES

private static final long MILLISECONDS_BETWEEN_LOG_MESSAGES

The count of milliseconds to wait, until a log message with the current count of statements is written.

See Also:

Constant Field Values

MINIMUM_JDBC_DRIVER_MAJOR_VERSION

private static final int MINIMUM_JDBC_DRIVER_MAJOR_VERSION

The minimum major version of the JDBC API that the driver needs to support.

See Also:

Constant Field Values

MINIMUM_JDBC_DRIVER_MINOR_VERSION

private static final int MINIMUM_JDBC_DRIVER_MINOR_VERSION

The minimum minor version of the JDBC API that the driver needs to support.

See Also:

Constant Field Values

context

private final GeneratorContext context

The generator context that is attached to this writer.

contextListener

private final ContextModelListener contextListener

The listener for model changes in the context when new classes are discovered.

connection

private final Connection connection

The database connection that was used when creating this generator.

closeConnection

private final boolean closeConnection

Indicates that we should close the connection at the end.

batchSupported

private final boolean batchSupported

Indicates that the database connection supports batch statements.

logStatements

private final boolean logStatements

Indicates that we log each statement for debugging purposes.

maxBatchSize

private final int maxBatchSize

The maximum count of statements per batch job.

plainStatement

private final Statement plainStatement

Used to execute all plain SQL statements.

preparedStatements

private final List<ConnectedStatementsWriter.PreparedInsertStatement> preparedStatements

All prepared statements for the tables.

availablePreparedStatements

private final Map<GeneratorTable,List<ConnectedStatementsWriter.PreparedInsertStatement>> availablePreparedStatements

All available prepared statements per table.

batchCount

private int batchCount

The count of statements executed in the current batch.

lastLogTime

private long lastLogTime

The last time that we have written a log message about the count of statements.

statementsCount

private long statementsCount

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

Constructor Detail

ConnectedStatementsWriter

private ConnectedStatementsWriter(Connection connection,
                                  boolean closeConnection,
                                  GeneratorContext context)
                           throws SQLException

Throws:

SQLException

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 Detail

buildConnection

private static Connection buildConnection(GeneratorContext context)
                                   throws SQLException

Throws:

SQLException

checkUpdate

private void checkUpdate(int updatedRows,
                         String sql)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractStatementsWriter

Throws:

IOException

closeBatch

private void closeBatch()
                 throws IOException

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

writePlainStatement

private void writePlainStatement(String sql)
                          throws IOException

Throws:

IOException

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

writeTableStatement

private void writeTableStatement(String sql)
                          throws IOException

Throws:

IOException

getConnection

@Generated(value="lombok")
public Connection getConnection()

The database connection that was used when creating this generator.

getStatementsCount

@Generated(value="lombok")
public long getStatementsCount()

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