wt.eff
Class UpgradeEffContextKey

java.lang.Object
  wt.eff.UpgradeEffContextKey

All Implemented Interfaces:

Migrator

public class UpgradeEffContextKey

extends Object

implements Migrator

Constructor Summary

UpgradeEffContextKey()

Method Summary

boolean

runMigration(Connection windchillDatabaseConnection, PersistentObjectManager pom, PrintWriter logWriter) Run the migration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UpgradeEffContextKey

public UpgradeEffContextKey()

Method Detail

runMigration

public boolean runMigration(Connection windchillDatabaseConnection,
                            PersistentObjectManager pom,
                            PrintWriter logWriter)
                     throws Throwable

Description copied from interface: Migrator

Run the migration.

Migrators should log all output to the given PrintWriter. This is the log that is created by RunMigrators. It is an autoflush writer.

Migrators should return true if they successfully completed migration and false otherwise. It is the migrator's responsibility to log failure reasons to the log.

Migrators should not concern themselves with committing the work on the connection. The MigratorRunner will commit the connection work after running each Migrator.

Specified by:

runMigration in interface Migrator

Parameters:

windchillDatabaseConnection - an open connection to the Windchill database

pom - a persistent object manager against the Windchill database

logWriter - an autoflush printwriter for logging any and all output

Throws:

Throwable - declared so that migrators can let exceptions contibuting to failure pass out of the method. The migrator runner will handle these by logging them.