oracle.ide.model
Class ProjectMigrator

java.lang.Object
  oracle.ide.migration.NodeMigrator
      oracle.ide.model.ProjectMigrator

public class ProjectMigrator
extends NodeMigrator

Project migrator. To lookup this migrator use the method NodeMigrator.getNodeMigrator(java.lang.String) specifying the name identifier: MIGRATOR_NAME. Migrator helpers registered with the ProjectMigrator will execute after migrator helpers registered with WorkspaceMigrator.

Field Summary

static java.lang.String

MIGRATOR_NAME String identifier used to lookup a specific node migrator.

Fields inherited from class oracle.ide.migration.NodeMigrator

MIGRATOR_MAP_DATA

Constructor Summary

ProjectMigrator()

Method Summary

protected void	callHelpersMigrate(MigrationInfo info, TraversableContext context)
protected NodeMigratorHelperReference[]	getHelperReferences(MigrationInfo info) Returns references to NodeMigratorHelpers that are newer than the version number stored in the project file.
protected NodeMigratorHelper[]	getHelpers(MigrationInfo info) Deprecated.
MigrationInfo	getMigrationInfo(Node node) Get the current MigrationInfo for the specified node.
protected java.lang.String	getMsg(MigrationInfo[] infos) Get the wizard welcome page message.
protected java.lang.String	getSummaryMsg(MigrationInfo[] infos) Get the message for the wizard summary page.
protected java.lang.String	getTitle() Get the wizard title.
protected float	getWeight() Returns the weight which we wish to give to the migrator when migrating it.
protected NodeMigratorHook.MigratorType	migratorType()
protected void	postMigrate(MigrationInfo[] infos, TraversableContext context) Method called after migration is complete.
protected void	preMigrate(MigrationInfo[] infos, TraversableContext context) Method called before migration is initiated.

Methods inherited from class oracle.ide.migration.NodeMigrator

addHelper, callHelperMigrate, checkVersioning, checkVersions, doMigration, doMigration, finishMigration, getHelperReferences, getHelpers, getInfoToMigratorMap, getLookupKey, getMigrationInfos, getNodeMigrator, getPages, getTraversableContext, invokeWizard, mapInfoToMigrator, migrate, migrate, removeHelper

Methods inherited from class java.lang.Object

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

Field Detail

MIGRATOR_NAME

public static final java.lang.String MIGRATOR_NAME

String identifier used to lookup a specific node migrator. This particular constant identifies the project migrator. Migrator name identifiers must be the class name of the node the migrator migrates.

Constructor Detail

ProjectMigrator

public ProjectMigrator()

Method Detail

migratorType

protected NodeMigratorHook.MigratorType migratorType()

Overrides:

migratorType in class NodeMigrator

callHelpersMigrate

protected void callHelpersMigrate(MigrationInfo info,
                                  TraversableContext context)

Overrides:

callHelpersMigrate in class NodeMigrator

preMigrate

protected void preMigrate(MigrationInfo[] infos,
                          TraversableContext context)

Description copied from class: NodeMigrator

Method called before migration is initiated. This method should be overriden if a migrator implementation needs to setup before migration starts. The default implementation does nothing.

Overrides:

preMigrate in class NodeMigrator

Parameters:

infos - information about the nodes that may require migration. All nodes held in the MigrationInfo must be of the same type.

context - contains a Map that can be obtained from the context using the name identifier: NodeMigrator.MIGRATOR_MAP_DATA. The information needed to do the migration is held by this map.

postMigrate

protected void postMigrate(MigrationInfo[] infos,
                           TraversableContext context)

Description copied from class: NodeMigrator

Method called after migration is complete. The default implementation does nothing.

Overrides:

postMigrate in class NodeMigrator

Parameters:

infos - information about the nodes that may require migration. All nodes held in the MigrationInfo must be of the same type.

context - contains addin specific migration data that is passed on to the helpers such that they can use that information when migrating their data.

getMsg

protected java.lang.String getMsg(MigrationInfo[] infos)

Description copied from class: NodeMigrator

Get the wizard welcome page message. Subclasses must implement this method to define the welcome page message.

Specified by:

getMsg in class NodeMigrator

Returns:

the welcome page message.

getTitle

protected java.lang.String getTitle()

Description copied from class: NodeMigrator

Get the wizard title. Subclasses must implement this method to define the wizard title.

Specified by:

getTitle in class NodeMigrator

Returns:

the wizard title.

getSummaryMsg

protected java.lang.String getSummaryMsg(MigrationInfo[] infos)

Description copied from class: NodeMigrator

Get the message for the wizard summary page. Subclasses must implement this method to define the summary page message.

Specified by:

getSummaryMsg in class NodeMigrator

Returns:

the summary page message.

getWeight

protected float getWeight()

Description copied from class: NodeMigrator

Returns the weight which we wish to give to the migrator when migrating it.

Overrides:

getWeight in class NodeMigrator

Returns:

a value in [0.00, 1.00] range. Lower values means "execute earlier". e.g. 0.00 means try to be the first, 1.00 means execute at the mercy of the migration scheduler.

getMigrationInfo

public MigrationInfo getMigrationInfo(Node node)

Description copied from class: NodeMigrator

Get the current MigrationInfo for the specified node.

Specified by:

getMigrationInfo in class NodeMigrator

Parameters:

node - the target node for which migration information is being requested.

getHelpers

@Deprecated
protected NodeMigratorHelper[] getHelpers(MigrationInfo info)

Deprecated.

Description copied from class: NodeMigrator

Get the NodeMigratorHelpers that are newer than the version number stored in the project file.

Overrides:

getHelpers in class NodeMigrator

getHelperReferences

protected NodeMigratorHelperReference[] getHelperReferences(MigrationInfo info)

Description copied from class: NodeMigrator

Returns references to NodeMigratorHelpers that are newer than the version number stored in the project file. These references point to actual NodeMigrationHelpers or NodeMigrationHelpers registered declaratively through the node-migrator hook.

Overrides:

getHelperReferences in class NodeMigrator

Returns:

an empty array (default implementation.)