org.apache.ddlutils.alteration

Class ColumnDefinitionChange

java.lang.Object

org.apache.ddlutils.alteration.TableChangeImplBase

org.apache.ddlutils.alteration.ColumnChangeImplBase

org.apache.ddlutils.alteration.ColumnDefinitionChange

All Implemented Interfaces:

ColumnChange, ModelChange, TableChange

public class ColumnDefinitionChange
extends ColumnChangeImplBase

Represents the change of one or more aspects of the definition of a column, such as data type or size, whether it is required or not, etc. Note that primary key status is not part of the definition.

Constructor Summary

Constructors

Constructor and Description
ColumnDefinitionChange(String tableName, String columnName, Column newColumnDef) Creates a new change object.

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(Database model, boolean caseSensitive) Applies this change to the given database.
Column	getNewColumn() Returns the new column definition.
static boolean	isAutoIncrementChanged(Column sourceColumn, Column targetColumn) Determines whether the auto increment status of the given target column is different from that of the given source column.
static boolean	isChanged(PlatformInfo platformInfo, Column sourceColumn, Column targetColumn) Determines whether the definition of the given target column is different from the one of the given source column.
static boolean	isDefaultValueChanged(Column sourceColumn, Column targetColumn) Determines whether the default value of the given target column is different from the one of the given source column.
static boolean	isRequiredStatusChanged(Column sourceColumn, Column targetColumn) Determines whether the required status of the given target column is different from that of the given source column.
static boolean	isSizeChanged(PlatformInfo platformInfo, Column sourceColumn, Column targetColumn) Determines whether the size or precision/scale of the given target column is different from that of the given source column.
static boolean	isSizeReduced(PlatformInfo platformInfo, Column sourceColumn, Column targetColumn) Determines whether the size or precision/scale of the given target column is smaller than that of the given source column.
static boolean	isTypeChanged(PlatformInfo platformInfo, Column sourceColumn, Column targetColumn) Determines whether the jdbc type of the given target column is different from the one of the given source column.

Methods inherited from class org.apache.ddlutils.alteration.ColumnChangeImplBase

findChangedColumn, getChangedColumn

Methods inherited from class org.apache.ddlutils.alteration.TableChangeImplBase

findChangedTable, getChangedTable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ddlutils.alteration.TableChange

findChangedTable, getChangedTable

Constructor Detail

ColumnDefinitionChange

public ColumnDefinitionChange(String tableName,
                      String columnName,
                      Column newColumnDef)

Creates a new change object.

Parameters:

tableName - The name of the table owning the changed column

columnName - The name of the changed column

newColumnDef - The new column definition

Method Detail

getNewColumn

public Column getNewColumn()

Returns the new column definition.

Returns:

The new column

isChanged

public static boolean isChanged(PlatformInfo platformInfo,
                Column sourceColumn,
                Column targetColumn)

Determines whether the definition of the given target column is different from the one of the given source column.

Parameters:

platformInfo - The info object for the current platform

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the definitions differ

isTypeChanged

public static boolean isTypeChanged(PlatformInfo platformInfo,
                    Column sourceColumn,
                    Column targetColumn)

Determines whether the jdbc type of the given target column is different from the one of the given source column. This method uses the platform info object to determine the actual jdbc type that the target column would have in the database, and compares that to the type of he source column.

Parameters:

platformInfo - The info object for the current platform

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the jdbc types differ

isSizeChanged

public static boolean isSizeChanged(PlatformInfo platformInfo,
                    Column sourceColumn,
                    Column targetColumn)

Determines whether the size or precision/scale of the given target column is different from that of the given source column. If size and precision/scale do not matter for the target column's type, then false is returned.

Parameters:

platformInfo - The info object for the current platform

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the sizes or precisions/scales differ

isSizeReduced

public static boolean isSizeReduced(PlatformInfo platformInfo,
                    Column sourceColumn,
                    Column targetColumn)

Determines whether the size or precision/scale of the given target column is smaller than that of the given source column. If size and precision/scale do not matter for the target column's type, then false is returned. Note that for columns with precision & scale, it also counted as being smaller if the scale of the target column is smaller than the one of the source column, regardless of whether the precision of the target column is smaller than precision of the source column or equal to it or even bigger. The reason for this is that the reduced scale would still potentially lead to truncation errors.

Parameters:

platformInfo - The info object for the current platform

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the size of the target column is smaller

isDefaultValueChanged

public static boolean isDefaultValueChanged(Column sourceColumn,
                            Column targetColumn)

Determines whether the default value of the given target column is different from the one of the given source column. This method compares the parsed default values instead of their representations in the columns.

Parameters:

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the default values differ

isRequiredStatusChanged

public static boolean isRequiredStatusChanged(Column sourceColumn,
                              Column targetColumn)

Determines whether the required status of the given target column is different from that of the given source column.

Parameters:

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the required status is different in the target column

isAutoIncrementChanged

public static boolean isAutoIncrementChanged(Column sourceColumn,
                             Column targetColumn)

Determines whether the auto increment status of the given target column is different from that of the given source column.

Parameters:

sourceColumn - The source column

targetColumn - The target column

Returns:

true if the auto increment status is different in the target column

apply

public void apply(Database model,
         boolean caseSensitive)

Applies this change to the given database.

Parameters:

model - The database

caseSensitive - Whether the case of names matters