org.rhq.core.db.ant.dbupgrade

Class SchemaSpec

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.rhq.core.db.ant.dbupgrade.SchemaSpec

All Implemented Interfaces:

Comparable, org.apache.tools.ant.TaskContainer

public class SchemaSpec
extends org.apache.tools.ant.Task
implements org.apache.tools.ant.TaskContainer, Comparable

An ANT task that defines a single, specific upgrade step that upgrades the schema to a particular version. Each SchemaSpec contains child tasks that define the actual work that needs to get done to perform this upgrade step.

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
SchemaSpec(DBUpgrader parent) Creates a new SchemaSpec object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTask(org.apache.tools.ant.Task schema_spec_task) Adds the given child task to the list of tasks.
int	compareTo(Object o) Compares the versions.
void	execute() Executes each task defined in this schema spec.
SchemaVersion	getVersion() Returns the schema version of this object.
void	initialize(Connection db_conn, DBUpgrader db_upgrader) Initializes this object with a database connection and a DBUpgrade task object.
void	setVersion(String version) This is the version to which this upgrade step takes the schema to.
String	toString()

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, wait, wait, wait

Constructor Detail

SchemaSpec

public SchemaSpec(DBUpgrader parent)

Creates a new SchemaSpec object.

Parameters:

parent -

Method Detail

setVersion

public void setVersion(String version)

This is the version to which this upgrade step takes the schema to. After this object's child tasks are run, the schema is considered to be at this version.

Parameters:

version -

getVersion

public SchemaVersion getVersion()
                         throws org.apache.tools.ant.BuildException

Returns the schema version of this object. This is the version to which this upgrade step takes the schema to. After this object's child tasks are run, the schema is considered to be at this version.

Returns:

the version

Throws:

org.apache.tools.ant.BuildException - if the version string was invalid

initialize

public void initialize(Connection db_conn,
              DBUpgrader db_upgrader)

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

Parameters:

db_conn -

db_upgrader -

addTask

public void addTask(org.apache.tools.ant.Task schema_spec_task)

Adds the given child task to the list of tasks. The task must be of type SchemaSpecTask.

Specified by:

addTask in interface org.apache.tools.ant.TaskContainer

Parameters:

schema_spec_task -

Throws:

org.apache.tools.ant.BuildException - if the task is not of the expected type

execute

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

Executes each task defined in this schema spec.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

compareTo

public int compareTo(Object o)

Compares the versions.

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)