au.id.simo.dbversion

Interface Task

All Known Implementing Classes:

AbstractTask, DataTask, SchemaTask, SQLFileTask, SQLTask, TransactionTask

public interface Task

Created by IntelliJ IDEA. User: gsimon Date: 17/11/2005 Time: 17:56:01 To change this template use File | Settings | File Templates.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComment()
String	getIdentifier() This String is used to identify a particular task.
Target	getTarget() May return null of this Task is run for all targets.
Version	getVersion() returns the version this task belongs to
boolean	isRun(Target target, Version version, boolean hasAlreadyRun) The implemetation of this method decides if this version is to be run or not.
boolean	isSchemaChange() Schema changes are sort to run before any data change.
boolean	runTask(Connection con)

Method Detail

isRun

boolean isRun(Target target,
            Version version,
            boolean hasAlreadyRun)

The implemetation of this method decides if this version is to be run or not.

Parameters:

target - the target that has been specified. Is often null.

version - the version of the schema the database is to be upgraded to

hasAlreadyRun - true if this task has already been run, false if it hasn't.

Returns:

true if this task is to be run given the paramters, false of not.

getVersion

Version getVersion()

returns the version this task belongs to

runTask

boolean runTask(Connection con)
                throws SQLException

Returns:

true if this task is to be recorded in the database as run, false if not.

Throws:

SQLException - if there was a problem executing.

getComment

String getComment()

Returns:

a human readable comment that is also discriptive, yet under about 100 chars in length. for example: "Create Table blah" or "add foo col to blah"

getIdentifier

String getIdentifier()

This String is used to identify a particular task. So it must be unique.

Returns:

a string that is unique to this task among all tasks in a given project. The full class name can do the job, or another contrived string may

isSchemaChange

boolean isSchemaChange()

Schema changes are sort to run before any data change.

Returns:

schema changes are handled diffrently from mere data entry.

getTarget

Target getTarget()

May return null of this Task is run for all targets.

Returns:

The target