org.fastnate.generator.statements

Class AbstractStatementsWriter

java.lang.Object

org.fastnate.generator.statements.AbstractStatementsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, StatementsWriter

Direct Known Subclasses:

ConnectedStatementsWriter, FileStatementsWriter, LiquibaseStatementsWriter, ListStatementsWriter

public abstract class AbstractStatementsWriter
extends Object
implements StatementsWriter

Base class for implementations of StatementsWriter.

Author:

Tobias Liefke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractStatementsWriter.AbstractTableStatement Base class for insert and update statements.
protected static class	AbstractStatementsWriter.InsertStatement Holds the information for an SQL Insert statement.
protected static class	AbstractStatementsWriter.PlainStatement A single (unparsed) SQL statement.
protected static class	AbstractStatementsWriter.UpdateStatement Holds the information for an SQL update statement.

Constructor Summary

Constructors

Constructor and Description
AbstractStatementsWriter()

Method Summary

Modifier and Type	Method and Description
void	close()
TableStatement	createInsertStatement(GeneratorDialect dialect, GeneratorTable table) Creates a container for a dedicated "insert into table" statement.
EntityStatement	createPlainStatement(GeneratorDialect dialect, String sql) Creates a container for a plain SQL statement, which is just executed "as is".
TableStatement	createUpdateStatement(GeneratorDialect dialect, GeneratorTable table, GeneratorColumn idColumn, ColumnExpression idValue) Creates a container for a dedicated "update table" statement.
void	flush() Flushes any open statements.
void	writeComment(String comment) Writes a SQL comment to the target.
void	writeSectionSeparator() Writes a new line to the target file to separate different sections in the SQL file.

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, writePlainStatement, writeStatement

Constructor Detail

AbstractStatementsWriter

public AbstractStatementsWriter()

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

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

Parameters:

dialect - the current database dialect

table - the name of the table

Returns:

the created statement

createPlainStatement

public EntityStatement createPlainStatement(GeneratorDialect dialect,
                                            String sql)

Description copied from interface: StatementsWriter

Creates a container for a plain SQL statement, which is just executed "as is".

Specified by:

createPlainStatement in interface StatementsWriter

Parameters:

dialect - the current database dialect

sql - the content of the sql statement (without any delimiter)

Returns:

the created statement

createUpdateStatement

public TableStatement createUpdateStatement(GeneratorDialect dialect,
                                            GeneratorTable table,
                                            GeneratorColumn idColumn,
                                            ColumnExpression idValue)

Description copied from interface: StatementsWriter

Creates a container for a dedicated "update table" statement.

Specified by:

createUpdateStatement in interface StatementsWriter

Parameters:

dialect - the current database dialect

table - the name of the affected table

idColumn - the column that contains the id of the changed entity

idValue - the expression for the id of the changed entity

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

Throws:

IOException - if the target throws an exception

writeComment

public void writeComment(String comment)
                  throws IOException

Description copied from interface: StatementsWriter

Writes a SQL comment to the target.

Specified by:

writeComment in interface StatementsWriter

Parameters:

comment - the comment to write

Throws:

IOException - if the target throws an exception

writeSectionSeparator

public void writeSectionSeparator()
                           throws IOException

Description copied from interface: StatementsWriter

Writes a new line to the target file to separate different sections in the SQL file.

Specified by:

writeSectionSeparator in interface StatementsWriter

Throws:

IOException - if the target throws such an exception