org.apache.ddlutils.platform.firebird

Class FirebirdBuilder

java.lang.Object

org.apache.ddlutils.platform.SqlBuilder

org.apache.ddlutils.platform.firebird.FirebirdBuilder

public class FirebirdBuilder
extends SqlBuilder

The SQL Builder for the FireBird database.

Field Summary

Fields inherited from class org.apache.ddlutils.platform.SqlBuilder

_log, LINE_SEPARATOR, SIZE_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
FirebirdBuilder(Platform platform) Creates a new builder instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(Database model, Table table, Column newColumn) Prints the SQL for adding a column to a table.
void	createForeignKeys(Database database) Creates the external foreignkey creation statements for all tables in the database.
void	createTable(Database database, Table table, Map parameters) Outputs the DDL to create the table along with any non-external constraints as well as with external primary keys and indices (but not foreign keys).
void	dropColumn(Table table, Column column) Writes the SQL to drop a column.
void	dropIndex(Table table, Index index) Generates the statement to drop a non-embedded index from the database.
void	dropTable(Table table) Outputs the DDL to drop the table.
protected String	getGeneratorName(Table table, Column column) Determines the name of the generator for an auto-increment column.
protected String	getNativeDefaultValue(Column column) Returns the native default value for the column.
String	getSelectLastIdentityValues(Table table) Generates the SQL for querying the id that was created in the last insertion operation.
void	insertColumn(Database model, Table table, Column newColumn, Column prevColumn) Writes the SQL to add/insert a column.
protected void	writeCastExpression(Column sourceColumn, Column targetColumn) Writes a cast expression that converts the value of the source column to the data type of the target column.
protected void	writeColumnAutoIncrementStmt(Table table, Column column) Prints that the column is an auto increment column.

Methods inherited from class org.apache.ddlutils.platform.SqlBuilder

addEscapedCharSequence, areEqual, columnsDiffer, copyData, createForeignKey, createForeignKeys, createIndex, createIndexes, createPrimaryKey, createTable, createTables, createTables, createTables, createTemporaryTable, createUniqueIdentifier, dropForeignKey, dropForeignKeys, dropTable, dropTables, dropTemporaryTable, escapeStringValue, getBareNativeType, getColumnName, getConstraintName, getDefaultValueHelper, getDeleteSql, getDelimitedIdentifier, getForeignKeyName, getIndent, getIndexName, getInsertSql, getMaxColumnNameLength, getMaxConstraintNameLength, getMaxForeignKeyNameLength, getMaxTableNameLength, getNativeType, getPlatform, getPlatformInfo, getSizeSpec, getSqlType, getSqlType, getTableName, getUpdateSql, getUpdateSql, getValueAsString, getValueDateFormat, getValueLocale, getValueNumberFormat, getValueTimeFormat, getWriter, isValidDefaultValue, print, printComment, printDefaultValue, printEndOfStatement, printIdentifier, printIndent, println, println, printlnIdentifier, printStartOfEmbeddedStatement, setIndent, setValueDateFormat, setValueLocale, setValueNumberFormat, setValueTimeFormat, setWriter, shortenName, shouldGeneratePrimaryKeys, writeAddIdentityColumnUsingAlterTable, writeColumn, writeColumnDefaultValue, writeColumnDefaultValueStmt, writeColumnNotNullableStmt, writeColumnNullableStmt, writeColumns, writeEmbeddedForeignKeysStmt, writeEmbeddedIndexCreateStmt, writeEmbeddedIndicesStmt, writeEmbeddedPrimaryKeysStmt, writeForeignKeyOnDeleteAction, writeForeignKeyOnUpdateAction, writeForeignReferences, writeLocalReferences, writePrimaryKeyStmt, writeTableAlterStmt, writeTableComment, writeTableCreationStmt, writeTableCreationStmtEnding

Methods inherited from class java.lang.Object

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

Constructor Detail

FirebirdBuilder

public FirebirdBuilder(Platform platform)

Creates a new builder instance.

Parameters:

platform - The plaftform this builder belongs to

Method Detail

createTable

public void createTable(Database database,
               Table table,
               Map parameters)
                 throws IOException

Outputs the DDL to create the table along with any non-external constraints as well as with external primary keys and indices (but not foreign keys).

Overrides:

createTable in class SqlBuilder

Parameters:

database - The database model

table - The table

parameters - Additional platform-specific parameters for the table creation

Throws:

IOException

dropTable

public void dropTable(Table table)
               throws IOException

Outputs the DDL to drop the table. Note that this method does not drop foreign keys to this table. Use SqlBuilder.dropTable(Database, Table) if you want that.

Overrides:

dropTable in class SqlBuilder

Parameters:

table - The table to drop

Throws:

IOException

getGeneratorName

protected String getGeneratorName(Table table,
                      Column column)

Determines the name of the generator for an auto-increment column.

Parameters:

table - The table

column - The auto-increment column

Returns:

The generator name

writeColumnAutoIncrementStmt

protected void writeColumnAutoIncrementStmt(Table table,
                                Column column)
                                     throws IOException

Prints that the column is an auto increment column.

Overrides:

writeColumnAutoIncrementStmt in class SqlBuilder

Parameters:

table - The table

column - The column

Throws:

IOException

getSelectLastIdentityValues

public String getSelectLastIdentityValues(Table table)

Generates the SQL for querying the id that was created in the last insertion operation. This is obviously only useful for pk fields that are auto-incrementing. A database that does not support this, will return null.

Overrides:

getSelectLastIdentityValues in class SqlBuilder

Parameters:

table - The table

Returns:

The sql, or null if the database does not support this

getNativeDefaultValue

protected String getNativeDefaultValue(Column column)

Returns the native default value for the column.

Overrides:

getNativeDefaultValue in class SqlBuilder

Parameters:

column - The column

Returns:

The native default value

createForeignKeys

public void createForeignKeys(Database database)
                       throws IOException

Creates the external foreignkey creation statements for all tables in the database.

Overrides:

createForeignKeys in class SqlBuilder

Parameters:

database - The database

Throws:

IOException

dropIndex

public void dropIndex(Table table,
             Index index)
               throws IOException

Generates the statement to drop a non-embedded index from the database.

Overrides:

dropIndex in class SqlBuilder

Parameters:

table - The table the index is on

index - The index to drop

Throws:

IOException

addColumn

public void addColumn(Database model,
             Table table,
             Column newColumn)
               throws IOException

Prints the SQL for adding a column to a table.

Overrides:

addColumn in class SqlBuilder

Parameters:

model - The database model

table - The table

newColumn - The new column

Throws:

IOException

insertColumn

public void insertColumn(Database model,
                Table table,
                Column newColumn,
                Column prevColumn)
                  throws IOException

Writes the SQL to add/insert a column.

Parameters:

model - The database model

table - The table

newColumn - The new column

prevColumn - The column after which the new column shall be added; null if the new column is to be inserted at the beginning

Throws:

IOException

dropColumn

public void dropColumn(Table table,
              Column column)
                throws IOException

Writes the SQL to drop a column.

Parameters:

table - The table

column - The column to drop

Throws:

IOException

writeCastExpression

protected void writeCastExpression(Column sourceColumn,
                       Column targetColumn)
                            throws IOException

Writes a cast expression that converts the value of the source column to the data type of the target column. Per default, simply the name of the source column is written thereby assuming that any casts happen implicitly.

Overrides:

writeCastExpression in class SqlBuilder

Parameters:

sourceColumn - The source column

targetColumn - The target column

Throws:

IOException