org.rhq.core.db.ant.dbupgrade

Class SST_AddColumn

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

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

org.rhq.core.db.ant.dbupgrade.SST_AddColumn

public class SST_AddColumn
extends SchemaSpecTask

Ant task to add a column to a database table. This task requires three attributes:

• table
• column
• columnType

This task accepts one optional attribute:

• precision - for use if the new columnType can take a precision specifier

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
SST_AddColumn()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
void	setColumn(String c) Sets the new column name.
void	setColumnType(String ct) Sets the generic DB column type of the new column.
void	setPrecision(String p) If the new column holds numeric data or data that can be limited to a particular precision, this defines its precision.
void	setTable(String t) Sets the name of the table that will get the new column added to it.

Methods inherited from class org.rhq.core.db.ant.dbupgrade.SchemaSpecTask

getConnection, getDatabaseType, getDBSpecificTypeName, getIgnoreError, getNewConnection, getTargetDBVendor, getTargetDBVersion, initialize, isDBTargeted, isIgnoreError, setIgnoreError, setTargetDBVendor, setTargetDBVersion, translateSqlType

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

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

SST_AddColumn

public SST_AddColumn()

Method Detail

setTable

public void setTable(String t)

Sets the name of the table that will get the new column added to it.

Parameters:

t - table name

setColumn

public void setColumn(String c)

Sets the new column name.

Parameters:

c - name of the new column

setColumnType

public void setColumnType(String ct)

Sets the generic DB column type of the new column.

Parameters:

ct - new column's generic column type

setPrecision

public void setPrecision(String p)

If the new column holds numeric data or data that can be limited to a particular precision, this defines its precision.

Parameters:

p - new column's precision

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

See Also:

Task.execute()