net.proteusframework.core.automation

Class DatabaseObjectConversion

java.lang.Object

net.proteusframework.core.automation.AbstractTask

net.proteusframework.core.automation.AbstractDataConversion

net.proteusframework.core.automation.DatabaseObjectConversion

All Implemented Interfaces:

DataConversion, Task

@Configurable
public class DatabaseObjectConversion
extends AbstractDataConversion

Database object data conversion.

Author:

Russ Tennant (russ@i2rd.com)

Field Summary

Fields inherited from class net.proteusframework.core.automation.AbstractDataConversion

_dependencies, _postDDL, _preDDL, _requiresDowntime, _version

Fields inherited from class net.proteusframework.core.automation.AbstractTask

_description, _identifier, _taskLogger

Fields inherited from interface net.proteusframework.core.automation.DataConversion

COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatabaseObjectConversion(DatabaseObjectType databaseObjectType, String identifier, String description, long version, boolean requiresDowntime, Set<DataConversion> dependencies, List<SQLStatement> preDDL, List<SQLStatement> postDDL) Constructor.

Method Summary

Modifier and Type	Method and Description
static DatabaseObjectConversion	create(DatabaseObjectType databaseObjectType, String identifier, String description, Long version, boolean requiresDowntime) Create a procedure conversion.
List<? extends SQLStatement>	execute(TaskArgument[] arguments) The SQL statements returned should not include any DDL statements.
List<SQLStatement>	getPostConversionDDL() Get any DDL statements that must be after the conversion.
List<SQLStatement>	getPreConversionDDL() Get any DDL statements that must be run before the conversion.
protected boolean	isValid(DataSource dataSource) Test if the conversion is valid.
DatabaseObjectConversion	limitToDatabase(String databaseProductName) Only run the data conversion if the product name of the database matches the specified product name.
DatabaseObjectConversion	limitToDatabase(String databaseProductName, int majorVersion, int minorVersion) Only run the data conversion if the product name of the database matches the specified product name.
DatabaseObjectConversion	withPostDDL(String ddl, String description) Post DDL.
DatabaseObjectConversion	withPreDDL(String ddl, String description) Pre DDL.

Methods inherited from class net.proteusframework.core.automation.AbstractDataConversion

checkResultSet, coerceList, equals, getDependencies, getValidationStatements, getVersion, hashCode, requiresDowntime, toString, validateResult

Methods inherited from class net.proteusframework.core.automation.AbstractTask

closeConnection, doesDatabaseObjectExist, doesDatabaseObjectExist, doesDatabaseObjectExist, doesDatabaseObjectExist, generateList, getAdditionalArguments, getArgumentMapping, getDataSourceArgument, getDescription, getIdentifier, getTableColumn, getTableColumn, validateArguments

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.proteusframework.core.automation.Task

getAdditionalArguments, getDescription, getIdentifier, validateArguments

Constructor Detail

DatabaseObjectConversion

protected DatabaseObjectConversion(DatabaseObjectType databaseObjectType,
                                   String identifier,
                                   String description,
                                   long version,
                                   boolean requiresDowntime,
                                   @Nullable
                                   Set<DataConversion> dependencies,
                                   @Nullable
                                   List<SQLStatement> preDDL,
                                   @Nullable
                                   List<SQLStatement> postDDL)

Constructor.

Parameters:

databaseObjectType - the database object type.

identifier - the identifier.

description - the description.

version - the version.

requiresDowntime - true if the conversion requires downtime. This indicates that it cannot be run while the server is running.

dependencies - any dependencies.

preDDL - the DDL dependencies.

postDDL - the DDL dependencies.

Method Detail

create

public static DatabaseObjectConversion create(DatabaseObjectType databaseObjectType,
                                              String identifier,
                                              String description,
                                              Long version,
                                              boolean requiresDowntime)

Create a procedure conversion.

Parameters:

databaseObjectType - the database object type.

identifier - the identifier.

description - the description.

version - the version.

requiresDowntime - true if the conversion requires downtime. This indicates that it cannot be run while the server is running.

Returns:

the data conversion.

execute

public List<? extends SQLStatement> execute(TaskArgument[] arguments)
                                     throws IllegalArgumentException,
                                            SQLException,
                                            IllegalArgumentException

The SQL statements returned should not include any DDL statements. DDL statements must be returned using getPreConversionDDL() or getPostConversionDDL() The SQL statements returned should not include any DDL statements. DDL statements must be returned using DataConversion.getPreConversionDDL() or DataConversion.getPostConversionDDL() Execute the task using the specified arguments. Some tasks such as DataConversions, will execute SQL statements. Other tasks may do things, like send an email in which case they will not return SQL statements.

Parameters:

arguments - the task arguments.

Returns:

an ordered list of loggable items from the task. If these are SQLStatements, the will be executed. Return an empty list if there or no loggable items.

Throws:

IllegalArgumentException - if the arguments are invalid.

SQLException - if a SQL Exception occurs.

getPostConversionDDL

public List<SQLStatement> getPostConversionDDL()

Description copied from interface: DataConversion

Get any DDL statements that must be after the conversion.

Specified by:

getPostConversionDDL in interface DataConversion

Overrides:

getPostConversionDDL in class AbstractDataConversion

Returns:

the DDL statements.

getPreConversionDDL

public List<SQLStatement> getPreConversionDDL()

Description copied from interface: DataConversion

Get any DDL statements that must be run before the conversion.

Specified by:

getPreConversionDDL in interface DataConversion

Overrides:

getPreConversionDDL in class AbstractDataConversion

Returns:

the DDL statements.

isValid

protected boolean isValid(DataSource dataSource)

Test if the conversion is valid. If it is not valid, it is skipped. This is useful to provide different stored procedures for different databases or database versions.

Parameters:

dataSource - the data source.

Returns:

if true, the conversion will proceed. If false, the conversion will be skipped.

limitToDatabase

public DatabaseObjectConversion limitToDatabase(String databaseProductName)

Only run the data conversion if the product name of the database matches the specified product name. If it doesn't match, the data conversion is skipped.

Parameters:

databaseProductName - the database product name.

Returns:

this.

limitToDatabase

public DatabaseObjectConversion limitToDatabase(String databaseProductName,
                                                int majorVersion,
                                                int minorVersion)

Only run the data conversion if the product name of the database matches the specified product name. If it doesn't match, the data conversion is skipped.

Parameters:

databaseProductName - the database product name. Examples: "PostgreSQL", "MySQL", "Oracle", "Apache Derby".

majorVersion - the major version number. If less than 1, this is not used to limit.

minorVersion - the minor version number. If less than 1, this is not used to limit.

Returns:

this.

withPostDDL

public DatabaseObjectConversion withPostDDL(String ddl,
                                            @Nullable
                                            String description)

Post DDL.

Parameters:

ddl - the DDL statement.

description - the description.

Returns:

this.

withPreDDL

public DatabaseObjectConversion withPreDDL(String ddl,
                                           @Nullable
                                           String description)

Pre DDL.

Parameters:

ddl - the DDL statement.

description - the description.

Returns:

this.