oracle.ide.model

Class IdeSystemMigrator

java.lang.Object

oracle.ide.migration.XMLMigrator

oracle.ide.model.IdeSystemMigrator

All Implemented Interfaces:

Migrator

public final class IdeSystemMigrator
extends XMLMigrator

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ide.migration.XMLMigrator

XMLMigrator.MigrationLogger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PROJECT
static java.lang.String	DEFAULT_SYSTEM_FILE
static int	DEFAULT_WORKSPACE
static int	SYSTEM_SETTINGS

Fields inherited from interface oracle.ide.migration.Migrator

JDEV_HOME_DIR, SYSTEM_DIR

Constructor Summary

Constructors

Constructor and Description
IdeSystemMigrator()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	adjustObject(java.io.File sourceDir, java.io.File destDir, java.lang.Object obj) Perform any postprocessing necessary before migrating the file.
boolean	canMigrate(int category, java.io.File sourceDir) Determine whether the settings can be migrated from the given directory.
java.lang.String	getDescription(int category) Get a one line description for a given migration category.
protected java.lang.String	getFileName() Get the filename to migrate.
protected java.lang.String	getNamespaceURI() Get the XML namespace URI.
static IdeSystem	getRestoredSystem() If a migration succeeded, then the restored system will be non-null.
protected java.lang.String	getRootTag() Get the XML root element tag.
protected java.io.File	getSourceFile(java.io.File sourceDir, java.io.File destDir) Get the File containing the information to be migrated.
java.lang.String[]	migrate(java.io.File sourceDir, java.io.File destDir) Migrate the settings from a given source directory to a given destination directory.
protected void	prepareToMigrate() Perform any preprocessing necessary before migrating the file.

Methods inherited from class oracle.ide.migration.XMLMigrator

categoryToIndex, getDestFile, getLogger, getMigrationCategories, getObjectStore, isAnyCategorySelected, isSelected, isValidCategory, readObject, setSelected, writeObject

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SYSTEM_FILE

public static final java.lang.String DEFAULT_SYSTEM_FILE

See Also:

Constant Field Values

SYSTEM_SETTINGS

public static final int SYSTEM_SETTINGS

See Also:

Constant Field Values

DEFAULT_PROJECT

public static final int DEFAULT_PROJECT

See Also:

Constant Field Values

DEFAULT_WORKSPACE

public static final int DEFAULT_WORKSPACE

See Also:

Constant Field Values

Constructor Detail

IdeSystemMigrator

public IdeSystemMigrator()

Method Detail

getDescription

public java.lang.String getDescription(int category)

Description copied from interface: Migrator

Get a one line description for a given migration category. A null result implies that no UI should be presented to the user for the given category.

canMigrate

public boolean canMigrate(int category,
                          java.io.File sourceDir)

Description copied from class: XMLMigrator

Determine whether the settings can be migrated from the given directory.

Specified by:

canMigrate in interface Migrator

Overrides:

canMigrate in class XMLMigrator

getSourceFile

protected java.io.File getSourceFile(java.io.File sourceDir,
                                     java.io.File destDir)

Description copied from class: XMLMigrator

Get the File containing the information to be migrated. Typically this would be equivalent to new File(sourceDir, getFileName()), though might be dependant upon individual category settings in a multi category Migrator.

Overrides:

getSourceFile in class XMLMigrator

getFileName

protected java.lang.String getFileName()

Description copied from class: XMLMigrator

Get the filename to migrate.

Specified by:

getFileName in class XMLMigrator

getNamespaceURI

protected java.lang.String getNamespaceURI()

Description copied from class: XMLMigrator

Get the XML namespace URI.

Specified by:

getNamespaceURI in class XMLMigrator

getRootTag

protected java.lang.String getRootTag()

Description copied from class: XMLMigrator

Get the XML root element tag.

Specified by:

getRootTag in class XMLMigrator

prepareToMigrate

protected void prepareToMigrate()

Description copied from class: XMLMigrator

Perform any preprocessing necessary before migrating the file. For subclasses of XMLMigrator, this would typically include making the necessary Object2Dom registrations.

Overrides:

prepareToMigrate in class XMLMigrator

adjustObject

protected java.lang.Object adjustObject(java.io.File sourceDir,
                                        java.io.File destDir,
                                        java.lang.Object obj)
                                 throws java.lang.Exception

Description copied from class: XMLMigrator

Perform any postprocessing necessary before migrating the file.

Overrides:

adjustObject in class XMLMigrator

Throws:

java.lang.Exception

getRestoredSystem

public static IdeSystem getRestoredSystem()

If a migration succeeded, then the restored system will be non-null. This should be used as the system. Otherwise, a new IdeSystem object can be created .

Returns:

restored IdeSystem object from migration.

migrate

public java.lang.String[] migrate(java.io.File sourceDir,
                                  java.io.File destDir)

Description copied from class: XMLMigrator

Migrate the settings from a given source directory to a given destination directory.

Specified by:

migrate in interface Migrator

Overrides:

migrate in class XMLMigrator