org.rhq.core.db.ant.dbupgrade

Class SchemaSpecTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.rhq.core.db.ant.dbupgrade.SchemaSpecTask

Direct Known Subclasses:

SST_AddColumn, SST_AlterColumn, SST_CreateSequence, SST_DeleteColumn, SST_DirectSQL, SST_DropForeignKeys, SST_DropSequence, SST_DropTable, SST_Insert, SST_JavaTask, SST_Update, SST_UpdateColumn

public abstract class SchemaSpecTask
extends org.apache.tools.ant.Task

A task that performs an individual step to help upgrade a schema to a particular version.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

Constructors

Constructor and Description
SchemaSpecTask()

Method Summary

Methods

Modifier and Type	Method and Description
Connection	getConnection() Returns a database connection this task can use.
DatabaseType	getDatabaseType() Returns the type of database being upgraded.
String	getDBSpecificTypeName(String generic_type_name) Returns the database-specific type name for the given generic type.
String	getIgnoreError()
Connection	getNewConnection() Get a new connection from this task's owning DBUpgrader object.
String	getTargetDBVendor() Sets the vendor name of the target DB where this SQL should run.
String	getTargetDBVersion() Gets the version string of the target DB where this SQL should run.
void	initialize(Connection db_conn, DBUpgrader db_upgrader) Initializes this task with a database connection and a DBUpgrader object.
boolean	isDBTargeted() Returns true if this task's database is targeted for this schema spec.
boolean	isIgnoreError()
void	setIgnoreError(String ignoreError)
void	setTargetDBVendor(String vendor) Sets the vendor name of the target DB where this SQL should run.
void	setTargetDBVersion(String version) Sets the version string of the target DB where this SQL should run.
int	translateSqlType(String generic_type_name) Given a generic type name, this returns the Types integer value of that type.

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaSpecTask

public SchemaSpecTask()

Method Detail

setTargetDBVendor

public void setTargetDBVendor(String vendor)

Sets the vendor name of the target DB where this SQL should run. Any other DB should not have this SQL executed on it.

Parameters:

vendor - database vendor

setTargetDBVersion

public void setTargetDBVersion(String version)

Sets the version string of the target DB where this SQL should run. Any other DB version should not have this SQL executed on it.

Parameters:

version - database version

getTargetDBVendor

public String getTargetDBVendor()

Sets the vendor name of the target DB where this SQL should run. Any other DB should not have this SQL executed on it.

Returns:

vendor string

getTargetDBVersion

public String getTargetDBVersion()

Gets the version string of the target DB where this SQL should run. Any other DB version should not have this SQL executed on it.

Returns:

version string

getIgnoreError

public String getIgnoreError()

setIgnoreError

public void setIgnoreError(String ignoreError)

isIgnoreError

public boolean isIgnoreError()

isDBTargeted

public boolean isDBTargeted()

Returns true if this task's database is targeted for this schema spec. Note that if getTargetDBVendor() is not specified, then any specified getTargetDBVersion() will cause a build exception to occur. You cannot specific a version string without indicating which vendor's database you are talking about.

Returns:

true if this schema spec task should run; false if this task's database is not targeted and thus this task should not execute

See Also:

getTargetDBVendor(), getTargetDBVersion()

initialize

public void initialize(Connection db_conn,
              DBUpgrader db_upgrader)

Initializes this task with a database connection and a DBUpgrader object.

Parameters:

db_conn -

db_upgrader -

getConnection

public Connection getConnection()

Returns a database connection this task can use.

Returns:

db connection

getNewConnection

public Connection getNewConnection()
                            throws SQLException

Get a new connection from this task's owning DBUpgrader object.

Returns:

db connection

Throws:

SQLException

getDatabaseType

public DatabaseType getDatabaseType()

Returns the type of database being upgraded.

Returns:

database type

translateSqlType

public int translateSqlType(String generic_type_name)
                     throws org.apache.tools.ant.BuildException

Given a generic type name, this returns the Types integer value of that type. In effect, it maps the generic type name with the JDBC SQL type ID.

Parameters:

generic_type_name -

Returns:

the JDBC SQL type ID of the given generic type

Throws:

org.apache.tools.ant.BuildException - if the type is not a known or supported type

getDBSpecificTypeName

public String getDBSpecificTypeName(String generic_type_name)
                             throws org.apache.tools.ant.BuildException

Returns the database-specific type name for the given generic type.

Parameters:

generic_type_name -

Returns:

the database specific type name that correlates to the generic type name

Throws:

org.apache.tools.ant.BuildException - no database specific type name was defined