oracle.ide.migration
Interface NodeMigratorHelper

public interface NodeMigratorHelper

The NodeMigratorHelper interface should be implemented by addins that need to migrate documents from previous versions of JDeveloper to a new JDeveloper version.

Addins that implement this interface need to register an instance of their implementation with the appropriate node migrator. Specific node migrators are looked up using the method: NodeMigrator@getNodeMigrator. The key used to lookup a migrator is built by calling the NodeMigrator@getLookupKey passing the class name of the node type handled by the migrator sought.

A node migrator can also be located using the migrator name constant generally defined in a migrator class. By convention, that constant is named: MIGRATOR_NAME. For example, to get at the workspace migrator do:

NodeMigrator.getNodeMigrator( WorkspaceMigrator.MIGRATOR_NAME );

This call returns the workspace migrator if available, otherwise, it returns null.

Method Summary

java.util.List	getPages(MigrationInfo[] infos, TraversableContext context) Get the traversal pages to be displayed by the node migration wizard.
void	migrate(MigrationInfo[] infos, TraversableContext context) Method called to migrate the nodes recorded in the specified MigrationInfo.

Method Detail

migrate

public void migrate(MigrationInfo[] infos,
                    TraversableContext context)

Method called to migrate the nodes recorded in the specified MigrationInfo.

Parameters:

infos - information about the nodes that may require migration. Addins that need to get at the node should do so by calling the MigrationInfo.getNodeCopy() method. Addins should never get at the original node.

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

getPages

public java.util.List getPages(MigrationInfo[] infos,
                               TraversableContext context)

Get the traversal pages to be displayed by the node migration wizard. Addins should store page data in the given context object. This object is given to the page when the user navigates to it.

Parameters:

infos - information about the nodes that may require migration. Addins that need to get at the node should do so by calling the MigrationInfo.getNodeCopy() method. Addins should never get at the original node.

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

Returns:

the traversable wizard pages.