Package ca.uhn.fhir.jpa.migrate.taskdef

Class BaseTask

java.lang.Object

ca.uhn.fhir.jpa.migrate.taskdef.BaseTask

Direct Known Subclasses:

AddIdGeneratorTask, ArbitrarySqlTask, BaseTableTask, DropIdGeneratorTask, ExecuteRawSqlTask, ForceIdMigrationCopyTask, ForceIdMigrationFixTask, InitializeSchemaTask, NopTask

public abstract class BaseTask
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseTask.ExecutedStatement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MIGRATION_VERSION_PATTERN
protected boolean	myCheckForExistingTables	Whether to check for existing tables before generating SQL
protected boolean	myPrettyPrint	Whether to generate the SQL in a 'readable format'

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseTask(String theProductVersion, String theSchemaVersion)

Method Summary

Modifier and Type	Method	Description
BaseTask	addFlag(TaskFlagEnum theFlag)	Adds a flag if it's not already present, otherwise this call is ignored.
void	addPrecondition(ExecuteTaskPrecondition thePrecondition)
protected void	captureExecutedStatement(String theTableName, String theSql, Object... theArguments)
protected abstract void	doExecute()
final boolean	equals(Object theObject)
void	execute()
void	executeSql(String theTableName, String theSql, Object... theArguments)
protected void	executeSqlListInTransaction(String theTableName, List<String> theSqlStatements)
protected abstract void	generateEquals(org.apache.commons.lang3.builder.EqualsBuilder theBuilder, BaseTask theOtherObject)
protected abstract void	generateHashCode(org.apache.commons.lang3.builder.HashCodeBuilder theBuilder)
int	getChangesCount()
DriverTypeEnum.ConnectionProperties	getConnectionProperties()
String	getDescription()
DriverTypeEnum	getDriverType()
List<BaseTask.ExecutedStatement>	getExecutedStatements()
MigrationTaskExecutionResultEnum	getExecutionResult()
String	getMigrationVersion()
String	getProductVersion()
String	getSchemaVersion()
org.springframework.transaction.support.TransactionTemplate	getTxTemplate()
boolean	hasFlag(TaskFlagEnum theFlag)
final int	hashCode()
boolean	initializedSchema()
boolean	isDoNothing()
boolean	isDryRun()
boolean	isHeavyweightSkippableTask()
boolean	isNoColumnShrink()
protected void	logInfo(org.slf4j.Logger theLog, String theFormattedMessage, Object... theArguments)
org.springframework.jdbc.core.JdbcTemplate	newJdbcTemplate()
BaseTask	setConnectionProperties(DriverTypeEnum.ConnectionProperties theConnectionProperties)
BaseTask	setDescription(String theDescription)
BaseTask	setDriverType(DriverTypeEnum theDriverType)
void	setDryRun(boolean theDryRun)
void	setNoColumnShrink(boolean theNoColumnShrink)
void	setOnlyAppliesToPlatforms(Set<DriverTypeEnum> theOnlyAppliesToPlatforms)
void	setPrettyPrint(boolean thePrettyPrint)
void	setTransactional(boolean theTransactional)	Some migrations can not be run in a transaction.
String	toString()
abstract void	validate()
void	validateVersion()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MIGRATION_VERSION_PATTERN

public static final String MIGRATION_VERSION_PATTERN

See Also:

• Constant Field Values

myCheckForExistingTables

protected boolean myCheckForExistingTables

Whether to check for existing tables before generating SQL

myPrettyPrint

protected boolean myPrettyPrint

Whether to generate the SQL in a 'readable format'

Constructor Details

BaseTask

protected BaseTask(String theProductVersion,
 String theSchemaVersion)

Method Details

addFlag

public BaseTask addFlag(@Nonnull
 TaskFlagEnum theFlag)

Adds a flag if it's not already present, otherwise this call is ignored.

Parameters:

theFlag - The flag, must not be null

setTransactional

public void setTransactional(boolean theTransactional)

Some migrations can not be run in a transaction. When this is true, executeSql(java.lang.String, java.lang.String, java.lang.Object...) will run without a transaction

setPrettyPrint

public void setPrettyPrint(boolean thePrettyPrint)

setOnlyAppliesToPlatforms

public void setOnlyAppliesToPlatforms(Set<DriverTypeEnum> theOnlyAppliesToPlatforms)

getProductVersion

public String getProductVersion()

getSchemaVersion

public String getSchemaVersion()

isNoColumnShrink

public boolean isNoColumnShrink()

setNoColumnShrink

public void setNoColumnShrink(boolean theNoColumnShrink)

isDryRun

public boolean isDryRun()

setDryRun

public void setDryRun(boolean theDryRun)

getDescription

public String getDescription()

setDescription

public BaseTask setDescription(String theDescription)

getExecutedStatements

public List<BaseTask.ExecutedStatement> getExecutedStatements()

getChangesCount

public int getChangesCount()

executeSql

public void executeSql(String theTableName,
 @Language("SQL")
 String theSql,
 Object... theArguments)

Parameters:

theTableName - This is only used for logging currently

theSql - The SQL statement

theArguments - The SQL statement arguments

executeSqlListInTransaction

protected void executeSqlListInTransaction(String theTableName,
 List<String> theSqlStatements)

captureExecutedStatement

protected void captureExecutedStatement(String theTableName,
 @Language("SQL")
 String theSql,
 Object... theArguments)

getConnectionProperties

public DriverTypeEnum.ConnectionProperties getConnectionProperties()

setConnectionProperties

public BaseTask setConnectionProperties(DriverTypeEnum.ConnectionProperties theConnectionProperties)

getDriverType

public DriverTypeEnum getDriverType()

setDriverType

public BaseTask setDriverType(DriverTypeEnum theDriverType)

validate

public abstract void validate()

getTxTemplate

public org.springframework.transaction.support.TransactionTemplate getTxTemplate()

newJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate newJdbcTemplate()

execute

public void execute()
             throws SQLException

Throws:

SQLException

toString

public String toString()

Overrides:

toString in class Object

doExecute

protected abstract void doExecute()
                           throws SQLException

Throws:

SQLException

getMigrationVersion

public String getMigrationVersion()

logInfo

protected void logInfo(org.slf4j.Logger theLog,
 String theFormattedMessage,
 Object... theArguments)

validateVersion

public void validateVersion()

addPrecondition

public void addPrecondition(ExecuteTaskPrecondition thePrecondition)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

generateHashCode

protected abstract void generateHashCode(org.apache.commons.lang3.builder.HashCodeBuilder theBuilder)

equals

public final boolean equals(Object theObject)

Overrides:

equals in class Object

generateEquals

protected abstract void generateEquals(org.apache.commons.lang3.builder.EqualsBuilder theBuilder,
 BaseTask theOtherObject)

initializedSchema

public boolean initializedSchema()

isDoNothing

public boolean isDoNothing()

isHeavyweightSkippableTask

public boolean isHeavyweightSkippableTask()

hasFlag

public boolean hasFlag(TaskFlagEnum theFlag)

getExecutionResult

public MigrationTaskExecutionResultEnum getExecutionResult()