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.

Version:

$Revision: 231306 $

Field Summary

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

_log, SIZE_PLACEHOLDER

Constructor Summary

FirebirdBuilder(Platform platform)
Creates a new builder instance.

Method Summary

void	createExternalForeignKeys(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	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.
protected void	processChange(Database currentModel, Database desiredModel, AddColumnChange change) Processes the addition of a column to a table.
protected void	processChange(Database currentModel, Database desiredModel, RemoveColumnChange change) Processes the removal of a column from a table.
protected void	processTableStructureChanges(Database currentModel, Database desiredModel, Table sourceTable, Table targetTable, Map parameters, List changes) Allows database-specific implementations to handle changes in a database specific manner.
protected void	writeColumnAutoIncrementStmt(Table table, Column column) Prints that the column is an auto increment column.
void	writeExternalIndexDropStmt(Table table, Index index) Generates the statement to drop a non-embedded index from the database.

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

addEscapedCharSequence, alterDatabase, applyForSelectedChanges, areEqual, columnsDiffer, createExternalForeignKeys, createTable, createTables, createTables, createTables, createTemporaryTable, createUniqueIdentifier, dropExternalForeignKeys, dropTable, dropTables, dropTemporaryTable, escapeStringValue, findCorrespondingForeignKey, getBareNativeType, getColumnName, getConstraintName, getDefaultValueHelper, getDeleteSql, getDelimitedIdentifier, getForeignKeyName, getIndent, getIndexName, getInsertSql, getMaxColumnNameLength, getMaxConstraintNameLength, getMaxForeignKeyNameLength, getMaxTableNameLength, getNativeType, getPlatform, getPlatformInfo, getRealTargetTableFor, getSqlType, getTableName, getTemporaryTableFor, getUpdateSql, getValueAsString, getValueDateFormat, getValueLocale, getValueNumberFormat, getValueTimeFormat, getWriter, isValidDefaultValue, print, printComment, printDefaultValue, printEndOfStatement, printIdentifier, printIndent, println, println, printlnIdentifier, printStartOfEmbeddedStatement, processChange, processChange, processChange, processChange, processChange, processChange, processChange, processChange, processChanges, processTableStructureChanges, processTableStructureChanges, setIndent, setValueDateFormat, setValueLocale, setValueNumberFormat, setValueTimeFormat, setWriter, shortenName, shouldGeneratePrimaryKeys, writeCastExpression, writeColumn, writeColumnDefaultValue, writeColumnDefaultValueStmt, writeColumnNotNullableStmt, writeColumnNullableStmt, writeColumns, writeCopyDataStatement, writeEmbeddedForeignKeysStmt, writeEmbeddedIndexCreateStmt, writeEmbeddedIndicesStmt, writeEmbeddedPrimaryKeysStmt, writeExternalForeignKeyCreateStmt, writeExternalForeignKeyDropStmt, writeExternalIndexCreateStmt, writeExternalIndicesCreateStmt, writeExternalPrimaryKeysCreateStmt, 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

createExternalForeignKeys

public void createExternalForeignKeys(Database database)
                               throws IOException

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

Overrides:

createExternalForeignKeys in class SqlBuilder

Parameters:

database - The database

Throws:

IOException

writeExternalIndexDropStmt

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

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

Overrides:

writeExternalIndexDropStmt in class SqlBuilder

Parameters:

table - The table the index is on

index - The index to drop

Throws:

IOException

processTableStructureChanges

protected void processTableStructureChanges(Database currentModel,
                                            Database desiredModel,
                                            Table sourceTable,
                                            Table targetTable,
                                            Map parameters,
                                            List changes)
                                     throws IOException

Allows database-specific implementations to handle changes in a database specific manner. Any handled change should be applied to the given current model (which is a copy of the real original model) and be removed from the list of changes.
In the default implementation, all AddPrimaryKeyChange changes are applied via an ALTER TABLE ADD CONSTRAINT statement.

Overrides:

processTableStructureChanges in class SqlBuilder

Parameters:

currentModel - The current database schema

desiredModel - The desired database schema

sourceTable - The original table

targetTable - The desired table

parameters - The creation parameters for the table

changes - The change objects for the target table

Throws:

IOException

processChange

protected void processChange(Database currentModel,
                             Database desiredModel,
                             AddColumnChange change)
                      throws IOException

Processes the addition of a column to a table.

Parameters:

currentModel - The current database schema

desiredModel - The desired database schema

change - The change object

Throws:

IOException

processChange

protected void processChange(Database currentModel,
                             Database desiredModel,
                             RemoveColumnChange change)
                      throws IOException

Processes the removal of a column from a table.

Parameters:

currentModel - The current database schema

desiredModel - The desired database schema

change - The change object

Throws:

IOException