org.rhq.core.db.ant.dbupgrade

Class SST_AlterColumn

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_AlterColumn

public class SST_AlterColumn
extends SchemaSpecTask

Ant task that can alter an existing column. This task requires these attributes:

• table
• column
• columnType + (the new column's generic type)
• nullable + (if true, the column can be NULL; otherwise it is NOT NULL)
• default + (the new default value of the column)

+ where only one of columnType, nullable or default is required. This task has two optional attributes:

• precision
• reindex - if true, the table will be re-indexed

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
void	setColumn(String c) Sets the name of the column that is to be altered.
void	setColumnType(String ct) Sets the column's new generic column type.
void	setDefault(String d) Sets the new default value of the column.
void	setNullable(String n) Sets the new nullable setting for the column - if true it can be null, if false it cannot.
void	setPrecision(String p) Sets the column's new precision.
void	setReindex(String r) Sets the reindex flag - this is a boolean string, "true" or "false".
void	setTable(String t) Sets the table name whose column is to be altered.

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_AlterColumn

public SST_AlterColumn()

Method Detail

setTable

public void setTable(String t)

Sets the table name whose column is to be altered.

Parameters:

t - table name

setColumn

public void setColumn(String c)

Sets the name of the column that is to be altered.

Parameters:

c - column name

setColumnType

public void setColumnType(String ct)

Sets the column's new generic column type.

Parameters:

ct - generic column type

setPrecision

public void setPrecision(String p)

Sets the column's new precision.

Parameters:

p - precision

setNullable

public void setNullable(String n)

Sets the new nullable setting for the column - if true it can be null, if false it cannot. The value of this attribute can be either true/false or respectively "NULL"/"NOT NULL".

Parameters:

n - nullable boolean string

Throws:

IllegalArgumentException - if boolean string is neither true nor false

setDefault

public void setDefault(String d)

Sets the new default value of the column.

Parameters:

d - default value

setReindex

public void setReindex(String r)

Sets the reindex flag - this is a boolean string, "true" or "false".

Parameters:

r - reindex flag

Throws:

IllegalArgumentException - if boolean string is neither true nor false

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