org.fastnate.generator.statements

Class FileStatementsWriter

java.lang.Object

org.fastnate.generator.statements.AbstractStatementsWriter

org.fastnate.generator.statements.FileStatementsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, StatementsWriter

Direct Known Subclasses:

PostgreSqlBulkWriter

public class FileStatementsWriter
extends AbstractStatementsWriter

Implementation of StatementsWriter which writes the statements into a Writer resp. File.

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 and Description
static String	OUTPUT_ENCODING_KEY Settings key for the encoding of the generated SQL file, if not given in the constructor.
static String	OUTPUT_FILE_KEY Settings key for the generated SQL file, if not given in the constructor.

Constructor Summary

Constructors

Constructor and Description
FileStatementsWriter(File file) Creates a new instance for a specifc file and UTF-8 encoding.
FileStatementsWriter(File file, Charset encoding) Creates a new instance for a specifc file and encoding.
FileStatementsWriter(GeneratorContext context) Creates a new instance of FileStatementsWriter.
FileStatementsWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
void	close()
protected static File	ensureDirectoryExists(File outputFile) Ensures, that the parent directory of the given output file exists.
void	flush() Flushes any open statements.
int	getStatementsCount() The count of written statements.
String	getStatementSeparator() The separator of the single statements, defaults to ";\n".
Writer	getWriter() Used to write the SQL statements.
void	setStatementSeparator(String statementSeparator) The separator of the single statements, defaults to ";\n".
void	write(String statements) Writes a bunch of SQL statements to the file.
void	writeComment(String comment) Writes a SQL comment to the target.
void	writePlainStatement(GeneratorDialect dialect, String sql) Writes a plain SQL statement.
void	writeSectionSeparator() Writes a new line to the target file to separate different sections in the SQL file.
void	writeStatement(EntityStatement statement) Writes the given statement to a file or database.

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

createInsertStatement, createPlainStatement, createUpdateStatement

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

OUTPUT_FILE_KEY

public static final String OUTPUT_FILE_KEY

Settings key for the generated SQL file, if not given in the constructor.

See Also:

Constant Field Values

OUTPUT_ENCODING_KEY

public static final String OUTPUT_ENCODING_KEY

Settings key for the encoding of the generated SQL file, if not given in the constructor.

See Also:

Constant Field Values

Constructor Detail

FileStatementsWriter

public FileStatementsWriter(File file)
                     throws FileNotFoundException

Creates a new instance for a specifc file and UTF-8 encoding.

Parameters:

file - the target file

Throws:

FileNotFoundException - if the file could not be opened for writing

FileStatementsWriter

public FileStatementsWriter(File file,
                            Charset encoding)
                     throws FileNotFoundException

Creates a new instance for a specifc file and encoding.

Parameters:

file - the target file

encoding - the charset of the target file

Throws:

FileNotFoundException - if the file could not be opened for writing

FileStatementsWriter

public FileStatementsWriter(GeneratorContext context)
                     throws FileNotFoundException

Creates a new instance of FileStatementsWriter. The target file and its encoding are taken from the settings OUTPUT_FILE_KEY and OUTPUT_ENCODING_KEY.

Parameters:

context - the context of the generation (for lookup of the properties)

Throws:

FileNotFoundException - if the file path is not available for writing

FileStatementsWriter

@ConstructorProperties(value="writer")
 @Generated(value="lombok")
public FileStatementsWriter(Writer writer)

Method Detail

ensureDirectoryExists

protected static File ensureDirectoryExists(File outputFile)

Ensures, that the parent directory of the given output file exists.

Parameters:

outputFile - the output file

Returns:

the output file (for chaining)

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

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

write

public void write(String statements)
           throws IOException

Writes a bunch of SQL statements to the file.

Parameters:

statements - the SQL statements (or anything else what should be added to the file)

Throws:

IOException - if the writer throws one

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

Overrides:

writeComment in class AbstractStatementsWriter

Parameters:

comment - the comment to write

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

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

Overrides:

writeSectionSeparator in class AbstractStatementsWriter

Throws:

IOException - if the target throws such an exception

writeStatement

public void writeStatement(EntityStatement statement)
                    throws IOException

Description copied from interface: StatementsWriter

Writes the given statement to a file or database.

Parameters:

statement - contains the values to write

Throws:

IOException - if the file or database throws an exception

getWriter

@Generated(value="lombok")
public Writer getWriter()

Used to write the SQL statements.

getStatementSeparator

@Generated(value="lombok")
public String getStatementSeparator()

The separator of the single statements, defaults to ";\n".

setStatementSeparator

@Generated(value="lombok")
public void setStatementSeparator(String statementSeparator)

The separator of the single statements, defaults to ";\n".

getStatementsCount

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

The count of written statements.