org.eclipse.emf.emfstore.internal.migration

Interface EMFStoreMigrator

All Known Implementing Classes:

EdaptMigrator

public interface EMFStoreMigrator

Migrates models in the given URIs to the most recent version. Users should check if this migrator can handle the given URI by calling canHandle, then checking if a migration is actually needed by calling needsMigration and if so use the migrate-Method to do so.

Author:

koegel, jfaltermeier

Method Summary

Modifier and Type	Method and Description
Set<org.eclipse.emf.common.util.URI>	canHandle(Set<org.eclipse.emf.common.util.URI> uris) Checks if this migrator can work with the specified URIs.
void	migrate(Set<org.eclipse.emf.common.util.URI> resources, org.eclipse.core.runtime.IProgressMonitor monitor) Migrate the models in the given URIs from the given source version to the most recent version.
Set<org.eclipse.emf.common.util.URI>	needsMigration(Set<org.eclipse.emf.common.util.URI> uris) Checks whether the models in the specified URIs need a to be migrated.

Method Detail

canHandle

Set<org.eclipse.emf.common.util.URI> canHandle(Set<org.eclipse.emf.common.util.URI> uris)

Checks if this migrator can work with the specified URIs.

Parameters:

uris - the physical URIs

Returns:

a set of URIs which cannot be handled. The set is empty of all uris may be handled

needsMigration

Set<org.eclipse.emf.common.util.URI> needsMigration(Set<org.eclipse.emf.common.util.URI> uris)

Checks whether the models in the specified URIs need a to be migrated.

Parameters:

uris - the physical URIs

Returns:

the URIs which need to be migrated. The set is empty if no URIs need to be migrated

migrate

void migrate(Set<org.eclipse.emf.common.util.URI> resources,
             org.eclipse.core.runtime.IProgressMonitor monitor)
      throws EMFStoreMigrationException

Migrate the models in the given URIs from the given source version to the most recent version.

Parameters:

resources - the URIs of the contents to migrate

monitor - a progress monitor

Throws:

EMFStoreMigrationException - if the migration fails.