Attachment #67870 for bug #187811

Lines 13-18 Link Here

(-)src/org/eclipse/gmf/tests/migration/GenericMigrationTest.java (+83 lines)
13		13
14	import java.io.File;	14	import java.io.File;
15	import java.io.IOException;	15	import java.io.IOException;
		16	import java.util.Collection;
		17	import java.util.Collections;
16		18
17	import junit.framework.TestCase;	19	import junit.framework.TestCase;
18		20
Lines 25-31 Link Here
25	import org.eclipse.emf.ecore.EcorePackage;	27	import org.eclipse.emf.ecore.EcorePackage;
26	import org.eclipse.emf.ecore.resource.Resource;	28	import org.eclipse.emf.ecore.resource.Resource;
27	import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;	29	import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
		30	import org.eclipse.gmf.internal.common.ToolingResourceFactory;
28	import org.eclipse.gmf.internal.common.migrate.MigrationConfig;	31	import org.eclipse.gmf.internal.common.migrate.MigrationConfig;
		32	import org.eclipse.gmf.internal.common.migrate.MigrationHelper;
		33	import org.eclipse.gmf.internal.common.migrate.MigrationHelperDelegate;
		34	import org.eclipse.gmf.internal.common.migrate.MigrationResource2;
29	import org.eclipse.gmf.internal.common.migrate.MigrationUtil;	35	import org.eclipse.gmf.internal.common.migrate.MigrationUtil;
30		36
31	/**	37	/**
Lines 131-134 Link Here
131	EPackage.Registry.INSTANCE.put(newNsURI, null);	137	EPackage.Registry.INSTANCE.put(newNsURI, null);
132	}	138	}
133	}	139	}
		140
		141	public void newTestRemovedAttribute() { //XXX: this test is turned off!
		142	final EObject testObject = newInstance();
		143	testObject.eSet(myAttrToRemove, "value");
		144
		145	final String oldNsURI = getMetaModel().getNsURI();
		146	EPackage.Registry.INSTANCE.put(oldNsURI, getMetaModel());
		147	final String newNsURI = oldNsURI + "/2";
		148	EPackage.Registry.INSTANCE.put(newNsURI, getMetaModel());
		149
		150	try {
		151	URI uri = null;
		152	try {
		153	uri = URI.createFileURI(File.createTempFile("removed", ".tests").getAbsolutePath());
		154	final ResourceSetImpl resourceSetImpl = new ResourceSetImpl();
		155	final Resource res = resourceSetImpl.createResource(uri);
		156	res.getContents().add(testObject);
		157	res.save(null);
		158	resourceSetImpl.getResources().remove(testObject);
		159	} catch (IOException ex) {
		160	fail(ex.toString());
		161	}
		162	// remove attr from metamodel
		163	myAttrToRemove.getEContainingClass().getEStructuralFeatures().remove(myAttrToRemove);
		164
		165	// try to load mm
		166	try {
		167	new ResourceSetImpl().createResource(uri).load(null);
		168	fail("Load should fail because of missing meta-model attribute");
		169	} catch (IOException ex) {
		170	// expected
		171	assertNotNull(ex.getMessage());
		172	assertTrue(ex.getMessage().contains(myAttrToRemove.getName()));
		173	}
		174
		175	EPackage.Registry.INSTANCE.put(oldNsURI, null);
		176
		177	Resource.Factory factory = new ToolingResourceFactory() {
		178
		179	@Override
		180	public Resource createResource(URI uri) {
		181	return new MigrationResource2(uri) {
		182	protected MigrationHelperDelegate createDelegate() {
		183	MigrationHelperDelegate delegate = new MigrationHelper.MigrationHelperDelegateImpl() {
		184	{
		185	registerDeletedAttributes(testObject.eClass(), myAttrToRemove.getName());
		186	}
		187	};
		188	return delegate;
		189	}
		190
		191	protected Collection<String> getBackwardSupportedURIs() {
		192	return Collections.<String>singleton(oldNsURI);
		193	}
		194
		195	@Override
		196	protected String getMetamodelNsURI() {
		197	return newNsURI;
		198	}
		199	};
		200	}
		201
		202	};
		203	Resource migrated = MigrationUtil.migrateModel(factory, uri).getLoadedResource();
204	assertNotNull(migrated);
205	assertTrue(migrated.getErrors().isEmpty() && migrated.getWarnings().isEmpty());
206	assertEquals(1, migrated.getContents().size());
207	EObject migratedObj = migrated.getContents().get(0);
208	assertEquals(testObject.eClass(), migratedObj.eClass());
209	} finally {
210	// clean-up, avoid any chances to affect other tests
211	// XXX MigrationConfig should be cleaned as well.
212	EPackage.Registry.INSTANCE.put(oldNsURI, null);
213	EPackage.Registry.INSTANCE.put(newNsURI, null);
214	}
215	}
216
134	}	217	}





		assertOnLoadModelMigrationSuccess(genmodelFileName);

		String gmfmapmodelFileName = "patch_138440.gmfmap"; //$NON-NLS-1$
		Exception caughtMapException = assertOrdinaryLoadModelProblems(gmfmapmodelFileName);
		assertTrue("expected IllegalArgumentException from metamodel EFactory", caughtMapException instanceof IllegalArgumentException); //$NON-NLS-1$


	void assertOnLoadModelMigrationSuccess(String modelFileName) throws Exception {
		URI uri = createURI(modelFileName);
		ModelLoadHelper loadHelper = new ModelLoadHelper(new ResourceSetImpl(), uri);
		
		assertTrue("Migration warning load status expected", loadHelper.getStatus().matches(IStatus.WARNING)); //$NON-NLS-1$

		EList<Resource.Diagnostic> warnings = loadHelper.getLoadedResource().getWarnings();
		assertEquals("Single Warning diagnostic expected", 1, warnings.size()); //$NON-NLS-1$		
		assertTrue("MigrationDiagnostic expected as warning", warnings.get(0) instanceof MigrationUtil.MigrationDiagnostic); //$NON-NLS-1$
		
		assertTrue(loadHelper.getLoadedResource().getErrors().isEmpty());
	}


		return caughtException;
	}

	/*
	GenDiagram
	Removed attrs:
	attr String paletteProviderClassName;
	attr ProviderPriority paletteProviderPriority;
	attr String propertyProviderClassName;
	attr ProviderPriority propertyProviderPriority;
	attr String referenceConnectionEditPolicyClassName;
	attr String externalNodeLabelHostLayoutEditPolicyClassName;
	attr String diagramFileCreatorClassName;
	attr String preferenceInitializerClassName;
	 */
	public void testGenDiagram() throws Exception {
		String genmodelFileName = "testGenDiagram.gmfgen"; //$NON-NLS-1$

		assertOnLoadModelMigrationSuccess(genmodelFileName);
	}

	/*
	FeatureLabelModelFacet 
	Removed refs:
	ref genmodel.GenFeature[1] metaFeature;
	 */
	public void testFeatureLabelModelFacet() throws Exception {
		String genmodelFileName = "testFeatureLabelModelFacet.gmfgen"; //$NON-NLS-1$
		
		Exception caughtGenException = assertOrdinaryLoadModelProblems(genmodelFileName);
		assertTrue("expected diagnostic exception", caughtGenException != null); //$NON-NLS-1$				

		assertOnLoadModelMigrationSuccess(genmodelFileName);
	}

//	/*
//	TypeLinkModelFacet 
//	Removed attrs:
//	attr String createCommandClassName;
//	 */
//	public void testTypeLinkModelFacet() throws Exception {
//		String genmodelFileName = "testTypeLinkModelFacet.gmfgen"; //$NON-NLS-1$
//		
//		Exception caughtGenException = assertOrdinaryLoadModelProblems(genmodelFileName);
//		assertTrue("expected diagnostic exception", caughtGenException != null); //$NON-NLS-1$				
//
//		assertOnLoadModelMigrationSuccess(genmodelFileName);
//	}

	public void testGenAuditRootDefaultAndNested() throws Exception {
		String genmodelFileName = "testGenAuditRootDefaultAndNested.gmfgen"; //$NON-NLS-1$
		

Added Link Here

(-)models/migration/testTypeLinkModelFacet.gmfgen (+8 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<gmfgen:TypeLinkModelFacet xmi:version="2.0"
3	xmlns:xmi="http://www.omg.org/XMI"
4	xmlns:gmfgen="http://www.eclipse.org/gmf/2005/GenModel"
5	createCommandClassName="CreateCommandClassName"/>
6	<modelElementSelector body="GenConstraintBody">
7	</modelElementSelector>
8	</gmfgen:TypeLinkModelFacet>

Added Link Here

(-)models/migration/testFeatureLabelModelFacet.gmfgen (+7 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<gmfgen:FeatureLabelModelFacet xmi:version="2.0"
3	xmlns:xmi="http://www.omg.org/XMI"
4	xmlns:gmfgen="http://www.eclipse.org/gmf/2005/GenModel">
5	<metaFeature name="DeletedFeature">
6	</metaFeature>
7	</gmfgen:FeatureLabelModelFacet>

Lines 14-20 Link Here

(-)plugin.xml (-1 / +1 lines)
14	</extension>	14	</extension>
15		15
16	<extension point="org.eclipse.emf.ecore.extension_parser">	16	<extension point="org.eclipse.emf.ecore.extension_parser">
17	<parser type="gmfgen" class="org.eclipse.gmf.internal.common.migrate.CompatibleToolResourceFactory$MigrateOnLoad" />	17	<parser type="gmfgen" class="org.eclipse.gmf.internal.codegen.util.GMFGenResource$Factory" />
18	</extension>	18	</extension>
19		19
20	<extension point="org.eclipse.team.core.fileTypes">	20	<extension point="org.eclipse.team.core.fileTypes">




/*
 * Copyright (c) 2007 Borland Software Corporation
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Borland - initial API and implementation
 */
package org.eclipse.gmf.internal.codegen.util;

import java.util.HashMap;
import java.util.Map;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.impl.EReferenceImpl;
import org.eclipse.gmf.codegen.gmfgen.GMFGenFactory;
import org.eclipse.gmf.codegen.gmfgen.GMFGenPackage;
import org.eclipse.gmf.codegen.gmfgen.GenAuditContainer;
import org.eclipse.gmf.codegen.gmfgen.GenAuditRoot;
import org.eclipse.gmf.codegen.gmfgen.GenAuditRule;
import org.eclipse.gmf.codegen.gmfgen.GenEditorGenerator;
import org.eclipse.gmf.internal.common.migrate.MigrationHelper;

public class GMFGenMigrationHelper extends MigrationHelper.MigrationHelperDelegateImpl {
	private EReference ourGenEditorGenerator_Audits;
	private EReference ourGenAuditContainer_ChildContainers;
	private EReference ourGenAuditContainer_Audits;
	
	public GMFGenMigrationHelper() {
	}

	public void init() {
		registerDeletedAttributes(GMFGenPackage.eINSTANCE.getEditorCandies(),
						"diagramFileCreatorClassName", //$NON-NLS-1$
						"preferenceInitializerClassName" //$NON-NLS-1$
		);
		registerDeletedAttributes(GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet(), "metaFeature"); //$NON-NLS-1$
		registerDeletedAttributes(GMFGenPackage.eINSTANCE.getProviderClassNames(), 
						"abstractParserClassName", //$NON-NLS-1$
						"structuralFeatureParserClassName", //$NON-NLS-1$
						"structuralFeaturesParserClassName", //$NON-NLS-1$
						"paletteProviderClassName", //$NON-NLS-1$
						"paletteProviderPriority", //$NON-NLS-1$
						"propertyProviderClassName", //$NON-NLS-1$
						"propertyProviderPriority" //$NON-NLS-1$
		);
		registerDeletedAttributes(GMFGenPackage.eINSTANCE.getEditPartCandies(), 
						"referenceConnectionEditPolicyClassName", //$NON-NLS-1$
						"externalNodeLabelHostLayoutEditPolicyClassName" //$NON-NLS-1$
		);
		registerDeletedAttributes(GMFGenPackage.eINSTANCE.getTypeLinkModelFacet(), "createCommandClassName"); //$NON-NLS-1$

		registerNarrowReferenceType(GMFGenPackage.eINSTANCE.getGenFeatureSeqInitializer_Initializers(),	GMFGenPackage.eINSTANCE.getGenFeatureValueSpec());
		{
			Map<String, EStructuralFeature> renamings = new HashMap<String, EStructuralFeature>();
			renamings.put("metaFeature", GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet_MetaFeatures()); //$NON-NLS-1$
			registerRenamedAttributes(GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet(), renamings);
		}
		ourGenEditorGenerator_Audits = new EReferenceImpl() {};
		ourGenEditorGenerator_Audits.setName("audits"); //$NON-NLS-1$
		ourGenEditorGenerator_Audits.setEType(GMFGenPackage.eINSTANCE.getGenAuditContainer());
		ourGenEditorGenerator_Audits.setContainment(true);
		ourGenEditorGenerator_Audits.setLowerBound(0);
		ourGenEditorGenerator_Audits.setUpperBound(1);
		ourGenAuditContainer_ChildContainers = new EReferenceImpl() {};
		ourGenAuditContainer_ChildContainers.setName("childContainers"); //$NON-NLS-1$
		ourGenAuditContainer_ChildContainers.setEType(GMFGenPackage.eINSTANCE.getGenAuditContainer());
		ourGenAuditContainer_ChildContainers.setContainment(true);
		ourGenAuditContainer_ChildContainers.setLowerBound(0);
		ourGenAuditContainer_ChildContainers.setUpperBound(-1);
		ourGenAuditContainer_Audits = new EReferenceImpl() {};
		ourGenAuditContainer_Audits.setName("audits"); //$NON-NLS-1$
		ourGenAuditContainer_Audits.setEType(GMFGenPackage.eINSTANCE.getGenAuditRule());
		ourGenAuditContainer_Audits.setContainment(true);
		ourGenAuditContainer_Audits.setLowerBound(0);
		ourGenAuditContainer_Audits.setUpperBound(-1);
		{
			Map<String, EStructuralFeature> renamings = new HashMap<String, EStructuralFeature>();
			renamings.put(ourGenEditorGenerator_Audits.getName(), ourGenEditorGenerator_Audits);
			registerRenamedAttributes(GMFGenPackage.eINSTANCE.getGenEditorGenerator(), renamings);
		}
		{
			Map<String, EStructuralFeature> renamings = new HashMap<String, EStructuralFeature>();
			renamings.put(ourGenAuditContainer_Audits.getName(), ourGenAuditContainer_Audits);
			renamings.put(ourGenAuditContainer_ChildContainers.getName(), ourGenAuditContainer_ChildContainers);
			registerRenamedAttributes(GMFGenPackage.eINSTANCE.getGenAuditContainer(), renamings);
		}
		registerRenamedType("CompositeFeatureLabelModelFacet", GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet()); //$NON-NLS-1$
	}
	
	public boolean setValue(EObject object, EStructuralFeature feature, Object value, int position) {
		if (ourGenEditorGenerator_Audits.equals(feature)) {
			GenEditorGenerator generator = (GenEditorGenerator) object;
			GenAuditContainer rootContainer = (GenAuditContainer) value;
			generator.setAudits(getOrCreateRoot(rootContainer));
		} else if (ourGenAuditContainer_ChildContainers.equals(feature)) {
			GenAuditContainer parent = (GenAuditContainer)object;
			GenAuditContainer container = (GenAuditContainer)value;
			container.getPath().addAll(parent.getPath());
			container.getPath().add(parent);
			getOrCreateRoot(parent).getCategories().add(container);
		} else if (ourGenAuditContainer_Audits.equals(feature)) {
			GenAuditContainer container = (GenAuditContainer)object;
			GenAuditRule rule = (GenAuditRule)value;
			rule.setCategory(container);
			getOrCreateRoot(container).getRules().add(rule);
		} else {
			// other cases are would be processed as defaults
			return super.setValue(object, feature, value, position);
		}
		return true;
	}

	private GenAuditRoot getOrCreateRoot(GenAuditContainer auditContainer) {
		GenAuditRoot result = auditContainer.getRoot();
		if (result == null) {
			result = GMFGenFactory.eINSTANCE.createGenAuditRoot();
			result.getCategories().add(auditContainer);
		}
		return result;
	}

}




/*
 * Copyright (c) 2007 Borland Software Corporation
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Borland - initial API and implementation
 */
package org.eclipse.gmf.internal.codegen.util;

import java.util.Arrays;
import java.util.Collection;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.gmf.codegen.gmfgen.GMFGenPackage;
import org.eclipse.gmf.internal.common.ToolingResourceFactory;
import org.eclipse.gmf.internal.common.migrate.MigrationHelperDelegate;
import org.eclipse.gmf.internal.common.migrate.MigrationResource2;

public class GMFGenResource extends MigrationResource2 {
	private Collection<String> myBackwardSupportedURIs;

	public static class Factory extends ToolingResourceFactory {
		@Override
		public Resource createResource(URI uri) {
			return new GMFGenResource(uri);
		}
	}

	private GMFGenResource(URI uri) {
		super(uri);
	}

	@Override
	protected MigrationHelperDelegate createDelegate() {
		GMFGenMigrationHelper migrationHelper = new GMFGenMigrationHelper();
		migrationHelper.init();
		return migrationHelper;
	}

	@Override
	protected Collection<String> getBackwardSupportedURIs() {
		if (myBackwardSupportedURIs == null) {
			myBackwardSupportedURIs = Arrays.asList(new String[] {
					"http://www.eclipse.org/gmf/2005/GenModel", //$NON-NLS-1$
			});
		}
		return myBackwardSupportedURIs;
	}

	protected String getMetamodelNsURI() {
		return GMFGenPackage.eNS_URI;
	}

}

Lines 14-20 Link Here

(-)plugin.xml (-1 / +1 lines)
14	</extension>	14	</extension>
15		15
16	<extension point="org.eclipse.emf.ecore.extension_parser">	16	<extension point="org.eclipse.emf.ecore.extension_parser">
17	<parser type="gmfmap" class="org.eclipse.gmf.internal.common.migrate.CompatibleToolResourceFactory$MigrateOnLoad" />	17	<parser type="gmfmap" class="org.eclipse.gmf.mappings.util.GMFMapResource$Factory" />
18	</extension>	18	</extension>
19		19
20	<extension point="org.eclipse.team.core.fileTypes">	20	<extension point="org.eclipse.team.core.fileTypes">




/*
 * Copyright (c) 2007 Borland Software Corporation
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Borland - initial API and implementation
 */
package org.eclipse.gmf.mappings.util;

import java.util.ArrayList;
import java.util.Collection;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.gmf.internal.common.migrate.MigrationHelper;
import org.eclipse.gmf.mappings.FeatureLabelMapping;
import org.eclipse.gmf.mappings.GMFMapPackage;
import org.eclipse.gmf.mappings.LabelMapping;
import org.eclipse.gmf.mappings.MappingEntry;

public class GMFMapMigrationHelper extends MigrationHelper.MigrationHelperDelegateImpl {
	private Collection<FeatureLabelMapping> myFeatureLabelMappings;
	
	protected GMFMapMigrationHelper() {
		super();
	}

	public void init() {
		registerNarrowReferenceType(GMFMapPackage.eINSTANCE.getFeatureSeqInitializer_Initializers(), GMFMapPackage.eINSTANCE.getFeatureValueSpec());
		registerNarrowReferenceType(GMFMapPackage.eINSTANCE.getMappingEntry_LabelMappings(), GMFMapPackage.eINSTANCE.getFeatureLabelMapping());
	}

	public void postProcess() {
		for (FeatureLabelMapping mapping : getSavedFeatureLabelMappings()) {
			if (mapping.getFeatures().isEmpty()) {
				MappingEntry entry = mapping.getMapEntry();
				entry.getLabelMappings().remove(mapping);
				LabelMapping newMapping = GMFMapPackage.eINSTANCE.getGMFMapFactory().createLabelMapping();
				newMapping.setDiagramLabel(mapping.getDiagramLabel());
				if (mapping.isReadOnly()) {
					newMapping.setReadOnly(true);
				}
				entry.getLabelMappings().add(newMapping);
			}
		}
	}

	public void processObject(EObject result) {
		if (result instanceof FeatureLabelMapping) {
			getSavedFeatureLabelMappings().add((FeatureLabelMapping) result);
		}
	}
	
	private Collection<FeatureLabelMapping> getSavedFeatureLabelMappings() {
		if (myFeatureLabelMappings == null) {
			myFeatureLabelMappings = new ArrayList<FeatureLabelMapping>();
		}
		return myFeatureLabelMappings;
	}
}




/*
 * Copyright (c) 2007 Borland Software Corporation
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Borland - initial API and implementation
 */
package org.eclipse.gmf.mappings.util;

import java.util.Arrays;
import java.util.Collection;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.gmf.internal.common.ToolingResourceFactory;
import org.eclipse.gmf.internal.common.migrate.MigrationHelperDelegate;
import org.eclipse.gmf.internal.common.migrate.MigrationResource2;
import org.eclipse.gmf.mappings.GMFMapPackage;

public class GMFMapResource extends MigrationResource2 {
	private Collection<String> myBackwardSupportedURIs;
	
	public static class Factory extends ToolingResourceFactory {
		@Override
		public Resource createResource(URI uri) {
			return new GMFMapResource(uri);
		}
	}

	private GMFMapResource(URI uri) {
		super(uri);
	}

	@Override
	protected MigrationHelperDelegate createDelegate() {
		GMFMapMigrationHelper migrationHelper = new GMFMapMigrationHelper();
		migrationHelper.init();
		return migrationHelper;
	}

	@Override
	protected Collection<String> getBackwardSupportedURIs() {
		if (myBackwardSupportedURIs == null) {
			myBackwardSupportedURIs = Arrays.asList(new String[] {
					"http://www.eclipse.org/gmf/2005/mappings", //$NON-NLS-1$
			});
		}
		return myBackwardSupportedURIs;
	}

	@Override
	protected String getMetamodelNsURI() {
		return GMFMapPackage.eNS_URI;
	}

}




	 * @return model-load-helper encapsulating the resource and its in-memory migrated contents.
	 */
	public static ModelLoadHelper migrateModel(URI modelResourceURI) {
		return migrateModel(new ToolingResourceFactory() {
			public Resource createResource(URI uri) {
				return new MigrationResource(uri);
			}
		}, modelResourceURI);
	}

	public static ModelLoadHelper migrateModel(final Resource.Factory factory, URI modelResourceURI) {
		if(modelResourceURI == null) {
			throw new IllegalArgumentException("null resource uri"); //$NON-NLS-1$
		}
		ResourceSetImpl rset = new ResourceSetImpl();
		rset.setResourceFactoryRegistry(new ResourceFactoryRegistryImpl() {			
			public Factory getFactory(URI uri) {
				return factory;
					public Resource createResource(URI uri) {
						return new MigrationResource(uri);
					}
				};
			}
		});





/*
 * Copyright (c) 2007 Borland Software Corporation
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Borland - initial API and implementation
 */
package org.eclipse.gmf.internal.common.migrate;

import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.emf.ecore.EFactory;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;

public interface MigrationHelperDelegate {
	
	public boolean setValue(EObject object, EStructuralFeature feature, Object value, int position);
	
	public EStructuralFeature getFeature(EClass eClass, String namespaceURI, String name, boolean isElement);
	
	public EClassifier getType(EFactory factory, String typeName);
	
	public EClass getStructuralFeatureType(EStructuralFeature feature);

	public EObject createObject(EFactory factory, EClassifier type);
	
	public void postProcess();

	public void processObject(EObject result);
}




package org.eclipse.gmf.internal.common.migrate;

import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.Map;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.xmi.XMLHelper;
import org.eclipse.emf.ecore.xmi.XMLLoad;
import org.eclipse.emf.ecore.xmi.impl.SAXXMIHandler;
import org.eclipse.emf.ecore.xmi.impl.XMILoadImpl;
import org.eclipse.gmf.internal.common.ToolingResourceFactory.ToolResource;
import org.xml.sax.helpers.DefaultHandler;

public abstract class MigrationResource2 extends ToolResource {

	private boolean isOldVersionDetected;
	
	protected MigrationResource2(URI uri) {
		super(uri);
	}

	public final void doLoad(InputStream inputStream, Map<?,?> options) throws IOException {
		try {
			isOldVersionDetected = false;
			super.doLoad(inputStream, options);
			handlePostLoad();
		} catch (IOException e) {
			handlePostLoadException(e);
			throw e;
		} catch (RuntimeException e) {
			handlePostLoadException(e);
			throw e;
		} finally {
			isOldVersionDetected = false;
		}
	}

	/*
	 * Create XMLLoad which handles old model migration at load-time 
	 * @see org.eclipse.emf.ecore.xmi.impl.XMIResourceImpl#createXMLLoad()
	 */
	protected XMLLoad createXMLLoad() {
		return new XMILoadImpl(createXMLHelper()) {

			protected DefaultHandler makeDefaultHandler() {
				return new SAXXMIHandler(resource, helper, options) {
					protected EPackage getPackageForURI(String uriString) {
						if(!getMetamodelNsURI().equals(uriString) && 
								getBackwardSupportedURIs().contains(uriString)) {					
								handleOldVersionDetected();
								return super.getPackageForURI(getMetamodelNsURI());
						}
						return super.getPackageForURI(uriString);
					}
				};
			}
		};
	}
	
	private void handleOldVersionDetected() {
		isOldVersionDetected = true;
	}
	
	protected void handlePostLoad() {
		if (isOldVersionDetected) {
			// create warning only in case of old model loading
			Diagnostic diagnostic = MigrationUtil.createMessageDiagnostic(this, Messages.oldModelVersionLoadedMigrationRequired);
			getWarnings().add(0, diagnostic);
		}
	}

	protected void handlePostLoadException(Exception e) {
		Diagnostic diagnostic = MigrationUtil.createMessageDiagnostic(this, Messages.oldModelVersionLoadErrorMigrationMayBeRequired);
		getErrors().add(0, diagnostic);
	}

	protected XMLHelper createXMLHelper() {
		MigrationHelperDelegate delegate = createDelegate();
		assert delegate != null;
		return new MigrationHelper(this, delegate);
	}

	protected abstract String getMetamodelNsURI();
	protected abstract Collection<String> getBackwardSupportedURIs();
	protected abstract MigrationHelperDelegate createDelegate();
}




/*
 * Copyright (c) 2007 Borland Software Corporation
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Borland - initial API and implementation
 */
package org.eclipse.gmf.internal.common.migrate;

import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.emf.ecore.EFactory;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.EcoreFactory;
import org.eclipse.emf.ecore.EcorePackage;
import org.eclipse.emf.ecore.xmi.XMLResource;
import org.eclipse.emf.ecore.xmi.impl.XMIHelperImpl;

public class MigrationHelper extends XMIHelperImpl {
	private final MigrationHelperDelegate myDelegate;

	public MigrationHelper(XMLResource resource, MigrationHelperDelegate delegate) {
		super(resource);
		myDelegate = delegate;
		assert delegate != null;
	}
	
	public static class MigrationHelperDelegateImpl implements MigrationHelperDelegate {

		public MigrationHelperDelegateImpl() {
			super();
		}

		private static EStructuralFeature ourDeletedAttribute = EcoreFactory.eINSTANCE.createEAttribute();
		static {
			ourDeletedAttribute.setName("attributeIsDeleted"); //$NON-NLS-1$
			ourDeletedAttribute.setEType(EcorePackage.eINSTANCE.getEString());
		}

		private Map<EClassifier, Collection<String>> myDeletedAttributes = new HashMap<EClassifier, Collection<String>>();
		private Map<EReference, EClass> myarrowReferenceTypes = new HashMap<EReference, EClass>();
		private Map<EClass, Map<String, EStructuralFeature>> myRenamedAttributes = new HashMap<EClass, Map<String, EStructuralFeature>>();
		private Map<String, EClassifier> myRenamedTypes = new HashMap<String, EClassifier>();
		
		public void registerDeletedAttributes(EClassifier classifier, String... deletedAttrNames) {
			assert !myDeletedAttributes.containsKey(classifier);
			myDeletedAttributes.put(classifier, Arrays.asList(deletedAttrNames));
		}
		
		public void registerNarrowReferenceType(EReference reference, EClass concreteType) {
			myarrowReferenceTypes.put(reference, concreteType);
		}
		
		public void registerRenamedAttributes(EClass eClass, Map<String, EStructuralFeature> renamedAttributes) {
			myRenamedAttributes.put(eClass, renamedAttributes);
		}
		
		public void registerRenamedType(String oldTypeName, EClassifier newType) {
			myRenamedTypes.put(oldTypeName, newType);
		}
		
		public void registerRenamedAttribute(EClass eClass, String oldName, EStructuralFeature newStructuralFeature) {
			Map<String, EStructuralFeature> renamedAttributes = myRenamedAttributes.get(eClass);
			if (renamedAttributes == null) {
				renamedAttributes = new HashMap<String, EStructuralFeature>();
			}
			renamedAttributes.put(oldName, newStructuralFeature);
			registerRenamedAttributes(eClass, renamedAttributes);
		}
		
		public boolean isAttributeDeleted(EClass clazz, String name) {
			Collection<String> deletedAttributes = myDeletedAttributes.get(clazz);
			boolean result = deletedAttributes != null && deletedAttributes.contains(name);
			for (Iterator<EClass> it=clazz.getEAllSuperTypes().iterator(); !result && it.hasNext();) {
				EClass nextParent = it.next();
				result = isAttributeDeleted(nextParent, name);
			}
			return result;
		}
		
		public EClass getNarrowReferenceType(EStructuralFeature feature) {
			return myarrowReferenceTypes.get(feature);
		}

		public EStructuralFeature getRenamedFeatureFor(EClass clazz, String name) {
		    Map<String, EStructuralFeature> renamings = myRenamedAttributes.get(clazz);
			EStructuralFeature result = renamings != null ? renamings.get(name) : null;
			for (Iterator<EClass> it=clazz.getEAllSuperTypes().iterator(); result == null && it.hasNext();) {
				EClass nextParent = it.next();
				result = getRenamedFeatureFor(nextParent, name);
			}
			return result;
		}

		public EClassifier getRenamedType(String typeName) {
			return myRenamedTypes.get(typeName);
		}

		public EClass getStructuralFeatureType(EStructuralFeature feature) {
			return getNarrowReferenceType(feature);
		}

		public boolean setValue(EObject object, EStructuralFeature feature, Object value, int position) {
			return ourDeletedAttribute.equals(feature);
		}

		public EStructuralFeature getFeature(EClass eClass, String namespaceURI, String name, boolean isElement) {
			EStructuralFeature result = null;
			EStructuralFeature rename = null;
			if (isAttributeDeleted(eClass, name)) {
				result = ourDeletedAttribute;
			} else if ((rename = getRenamedFeatureFor(eClass, name)) != null) {
				result = rename;
			}
			return result;
		}

		public EClassifier getType(EFactory factory, String typeName) {
			EClassifier result = null;
			EClassifier type = getRenamedType(typeName);
			if (type != null) {
				result = type;
			}
			return result;
		}

		public EObject createObject(EFactory factory, EClassifier type) {
			return null;
		}
		
		public void postProcess() {
		}

		public void processObject(EObject result) {
		}
	}

	public EObject createObject(EFactory factory, EClassifier type) {
		EObject result = myDelegate.createObject(factory, type);
		if (result == null) {
			result = super.createObject(factory, type);
		}
		myDelegate.processObject(result);
		return result;
	}

	public void setValue(EObject object, EStructuralFeature feature, Object value, int position) {
		if (!myDelegate.setValue(object, feature, value, position)) {
			super.setValue(object, feature, value, position);
		}
	}

	public EStructuralFeature getFeature(EClass eClass, String namespaceURI, String name, boolean isElement) {
		EStructuralFeature result = myDelegate.getFeature(eClass, namespaceURI, name, isElement);
		if (result == null) {
			result = super.getFeature(eClass, namespaceURI, name);
		}
		EClass narrow = myDelegate.getStructuralFeatureType(result);
		if (narrow != null) {
			result.setEType(narrow);
		}
		return result;
	}
	
	public EClassifier getType(EFactory factory, String typeName) {
		EClassifier result = myDelegate.getType(factory, typeName);
		if (result == null) {
			result = super.getType(factory, typeName);
		}
		return result;
	}

	public void popContext() {
		myDelegate.postProcess();
	}
}

Return to bug 187811

Lines 45-51 Link Here

(-)src/org/eclipse/gmf/tests/migration/MigrationPatchesTest.java (-13 / +42 lines)
45		45
46	assertOnLoadModelMigrationSuccess(genmodelFileName);	46	assertOnLoadModelMigrationSuccess(genmodelFileName);
47		47
48	String gmfmapmodelFileName = "patch_138440.gmfmap"; //$NON-NLS-1$	48	String gmfmapmodelFileName = "patch_138440.gmfmap"; //$NON-NLS-1$
49	Exception caughtMapException = assertOrdinaryLoadModelProblems(gmfmapmodelFileName);	49	Exception caughtMapException = assertOrdinaryLoadModelProblems(gmfmapmodelFileName);
50	assertTrue("expected IllegalArgumentException from metamodel EFactory", caughtMapException instanceof IllegalArgumentException); //$NON-NLS-1$	50	assertTrue("expected IllegalArgumentException from metamodel EFactory", caughtMapException instanceof IllegalArgumentException); //$NON-NLS-1$
51		51
Lines 82-92 Link Here
82	void assertOnLoadModelMigrationSuccess(String modelFileName) throws Exception {	82	void assertOnLoadModelMigrationSuccess(String modelFileName) throws Exception {
83	URI uri = createURI(modelFileName);	83	URI uri = createURI(modelFileName);
84	ModelLoadHelper loadHelper = new ModelLoadHelper(new ResourceSetImpl(), uri);	84	ModelLoadHelper loadHelper = new ModelLoadHelper(new ResourceSetImpl(), uri);
		85
85	assertTrue("Migration warning load status expected", loadHelper.getStatus().matches(IStatus.WARNING)); //$NON-NLS-1$	86	assertTrue("Migration warning load status expected", loadHelper.getStatus().matches(IStatus.WARNING)); //$NON-NLS-1$
86
87	EList<Resource.Diagnostic> warnings = loadHelper.getLoadedResource().getWarnings();	87	EList<Resource.Diagnostic> warnings = loadHelper.getLoadedResource().getWarnings();
88	assertEquals("Single Warning diagnostic expected", 1, warnings.size()); //$NON-NLS-1$	88	assertEquals("Single Warning diagnostic expected", 1, warnings.size()); //$NON-NLS-1$
89	assertTrue("MigrationDiagnostic expected as warning", warnings.get(0) instanceof MigrationUtil.MigrationDiagnostic); //$NON-NLS-1$	89	assertTrue("MigrationDiagnostic expected as warning", warnings.get(0) instanceof MigrationUtil.MigrationDiagnostic); //$NON-NLS-1$
		90
90	assertTrue(loadHelper.getLoadedResource().getErrors().isEmpty());	91	assertTrue(loadHelper.getLoadedResource().getErrors().isEmpty());
91	}	92	}
92		93
Lines 108-124 Link Here
108	return caughtException;	109	return caughtException;
109	}	110	}
110		111
111	/*	112	/*
112	GenDiagram	113	GenDiagram
113	Removed attrs:	114	Removed attrs:
114	attr String paletteProviderClassName;	115	attr String paletteProviderClassName;
115	attr ProviderPriority paletteProviderPriority;	116	attr ProviderPriority paletteProviderPriority;
116	attr String propertyProviderClassName;	117	attr String propertyProviderClassName;
117	attr ProviderPriority propertyProviderPriority;	118	attr ProviderPriority propertyProviderPriority;
118	attr String referenceConnectionEditPolicyClassName;	119	attr String referenceConnectionEditPolicyClassName;
119	attr String externalNodeLabelHostLayoutEditPolicyClassName;	120	attr String externalNodeLabelHostLayoutEditPolicyClassName;
120	attr String diagramFileCreatorClassName;	121	attr String diagramFileCreatorClassName;
121	attr String preferenceInitializerClassName;	122	attr String preferenceInitializerClassName;
122	*/	123	*/
123	public void testGenDiagram() throws Exception {	124	public void testGenDiagram() throws Exception {
124	String genmodelFileName = "testGenDiagram.gmfgen"; //$NON-NLS-1$	125	String genmodelFileName = "testGenDiagram.gmfgen"; //$NON-NLS-1$
Lines 129-134 Link Here
129	assertOnLoadModelMigrationSuccess(genmodelFileName);	130	assertOnLoadModelMigrationSuccess(genmodelFileName);
130	}	131	}
131		132
		133	/*
		134	FeatureLabelModelFacet
		135	Removed refs:
		136	ref genmodel.GenFeature[1] metaFeature;
		137	*/
		138	public void testFeatureLabelModelFacet() throws Exception {
		139	String genmodelFileName = "testFeatureLabelModelFacet.gmfgen"; //$NON-NLS-1$
		140
		141	Exception caughtGenException = assertOrdinaryLoadModelProblems(genmodelFileName);
		142	assertTrue("expected diagnostic exception", caughtGenException != null); //$NON-NLS-1$
		143
		144	assertOnLoadModelMigrationSuccess(genmodelFileName);
		145	}
		146
		147	// /*
		148	// TypeLinkModelFacet
		149	// Removed attrs:
		150	// attr String createCommandClassName;
		151	// */
		152	// public void testTypeLinkModelFacet() throws Exception {
		153	// String genmodelFileName = "testTypeLinkModelFacet.gmfgen"; //$NON-NLS-1$
		154	//
		155	// Exception caughtGenException = assertOrdinaryLoadModelProblems(genmodelFileName);
		156	// assertTrue("expected diagnostic exception", caughtGenException != null); //$NON-NLS-1$
		157	//
		158	// assertOnLoadModelMigrationSuccess(genmodelFileName);
		159	// }
		160
132	public void testGenAuditRootDefaultAndNested() throws Exception {	161	public void testGenAuditRootDefaultAndNested() throws Exception {
133	String genmodelFileName = "testGenAuditRootDefaultAndNested.gmfgen"; //$NON-NLS-1$	162	String genmodelFileName = "testGenAuditRootDefaultAndNested.gmfgen"; //$NON-NLS-1$
134		163

Added Link Here

(-)src/org/eclipse/gmf/internal/codegen/util/GMFGenMigrationHelper.java (+127 lines)
1	/*
2	* Copyright (c) 2007 Borland Software Corporation
3	*
4	* All rights reserved. This program and the accompanying materials are made
5	* available under the terms of the Eclipse Public License v1.0 which
6	* accompanies this distribution, and is available at
7	* http://www.eclipse.org/legal/epl-v10.html
8	*
9	* Contributors: Borland - initial API and implementation
10	*/
11	package org.eclipse.gmf.internal.codegen.util;
12
13	import java.util.HashMap;
14	import java.util.Map;
15
16	import org.eclipse.emf.ecore.EObject;
17	import org.eclipse.emf.ecore.EReference;
18	import org.eclipse.emf.ecore.EStructuralFeature;
19	import org.eclipse.emf.ecore.impl.EReferenceImpl;
20	import org.eclipse.gmf.codegen.gmfgen.GMFGenFactory;
21	import org.eclipse.gmf.codegen.gmfgen.GMFGenPackage;
22	import org.eclipse.gmf.codegen.gmfgen.GenAuditContainer;
23	import org.eclipse.gmf.codegen.gmfgen.GenAuditRoot;
24	import org.eclipse.gmf.codegen.gmfgen.GenAuditRule;
25	import org.eclipse.gmf.codegen.gmfgen.GenEditorGenerator;
26	import org.eclipse.gmf.internal.common.migrate.MigrationHelper;
27
28	public class GMFGenMigrationHelper extends MigrationHelper.MigrationHelperDelegateImpl {
29	private EReference ourGenEditorGenerator_Audits;
30	private EReference ourGenAuditContainer_ChildContainers;
31	private EReference ourGenAuditContainer_Audits;
32
33	public GMFGenMigrationHelper() {
34	}
35
36	public void init() {
37	registerDeletedAttributes(GMFGenPackage.eINSTANCE.getEditorCandies(),
38	"diagramFileCreatorClassName", //$NON-NLS-1$
39	"preferenceInitializerClassName" //$NON-NLS-1$
40	);
41	registerDeletedAttributes(GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet(), "metaFeature"); //$NON-NLS-1$
42	registerDeletedAttributes(GMFGenPackage.eINSTANCE.getProviderClassNames(),
43	"abstractParserClassName", //$NON-NLS-1$
44	"structuralFeatureParserClassName", //$NON-NLS-1$
45	"structuralFeaturesParserClassName", //$NON-NLS-1$
46	"paletteProviderClassName", //$NON-NLS-1$
47	"paletteProviderPriority", //$NON-NLS-1$
48	"propertyProviderClassName", //$NON-NLS-1$
49	"propertyProviderPriority" //$NON-NLS-1$
50	);
51	registerDeletedAttributes(GMFGenPackage.eINSTANCE.getEditPartCandies(),
52	"referenceConnectionEditPolicyClassName", //$NON-NLS-1$
53	"externalNodeLabelHostLayoutEditPolicyClassName" //$NON-NLS-1$
54	);
55	registerDeletedAttributes(GMFGenPackage.eINSTANCE.getTypeLinkModelFacet(), "createCommandClassName"); //$NON-NLS-1$
56
57	registerNarrowReferenceType(GMFGenPackage.eINSTANCE.getGenFeatureSeqInitializer_Initializers(), GMFGenPackage.eINSTANCE.getGenFeatureValueSpec());
58	{
59	Map<String, EStructuralFeature> renamings = new HashMap<String, EStructuralFeature>();
60	renamings.put("metaFeature", GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet_MetaFeatures()); //$NON-NLS-1$
61	registerRenamedAttributes(GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet(), renamings);
62	}
63	ourGenEditorGenerator_Audits = new EReferenceImpl() {};
64	ourGenEditorGenerator_Audits.setName("audits"); //$NON-NLS-1$
65	ourGenEditorGenerator_Audits.setEType(GMFGenPackage.eINSTANCE.getGenAuditContainer());
66	ourGenEditorGenerator_Audits.setContainment(true);
67	ourGenEditorGenerator_Audits.setLowerBound(0);
68	ourGenEditorGenerator_Audits.setUpperBound(1);
69	ourGenAuditContainer_ChildContainers = new EReferenceImpl() {};
70	ourGenAuditContainer_ChildContainers.setName("childContainers"); //$NON-NLS-1$
71	ourGenAuditContainer_ChildContainers.setEType(GMFGenPackage.eINSTANCE.getGenAuditContainer());
72	ourGenAuditContainer_ChildContainers.setContainment(true);
73	ourGenAuditContainer_ChildContainers.setLowerBound(0);
74	ourGenAuditContainer_ChildContainers.setUpperBound(-1);
75	ourGenAuditContainer_Audits = new EReferenceImpl() {};
76	ourGenAuditContainer_Audits.setName("audits"); //$NON-NLS-1$
77	ourGenAuditContainer_Audits.setEType(GMFGenPackage.eINSTANCE.getGenAuditRule());
78	ourGenAuditContainer_Audits.setContainment(true);
79	ourGenAuditContainer_Audits.setLowerBound(0);
80	ourGenAuditContainer_Audits.setUpperBound(-1);
81	{
82	Map<String, EStructuralFeature> renamings = new HashMap<String, EStructuralFeature>();
83	renamings.put(ourGenEditorGenerator_Audits.getName(), ourGenEditorGenerator_Audits);
84	registerRenamedAttributes(GMFGenPackage.eINSTANCE.getGenEditorGenerator(), renamings);
85	}
86	{
87	Map<String, EStructuralFeature> renamings = new HashMap<String, EStructuralFeature>();
88	renamings.put(ourGenAuditContainer_Audits.getName(), ourGenAuditContainer_Audits);
89	renamings.put(ourGenAuditContainer_ChildContainers.getName(), ourGenAuditContainer_ChildContainers);
90	registerRenamedAttributes(GMFGenPackage.eINSTANCE.getGenAuditContainer(), renamings);
91	}
92	registerRenamedType("CompositeFeatureLabelModelFacet", GMFGenPackage.eINSTANCE.getFeatureLabelModelFacet()); //$NON-NLS-1$
93	}
94
95	public boolean setValue(EObject object, EStructuralFeature feature, Object value, int position) {
96	if (ourGenEditorGenerator_Audits.equals(feature)) {
97	GenEditorGenerator generator = (GenEditorGenerator) object;
98	GenAuditContainer rootContainer = (GenAuditContainer) value;
99	generator.setAudits(getOrCreateRoot(rootContainer));
100	} else if (ourGenAuditContainer_ChildContainers.equals(feature)) {
101	GenAuditContainer parent = (GenAuditContainer)object;
102	GenAuditContainer container = (GenAuditContainer)value;
103	container.getPath().addAll(parent.getPath());
104	container.getPath().add(parent);
105	getOrCreateRoot(parent).getCategories().add(container);
106	} else if (ourGenAuditContainer_Audits.equals(feature)) {
107	GenAuditContainer container = (GenAuditContainer)object;
108	GenAuditRule rule = (GenAuditRule)value;
109	rule.setCategory(container);
110	getOrCreateRoot(container).getRules().add(rule);
111	} else {
112	// other cases are would be processed as defaults
113	return super.setValue(object, feature, value, position);
114	}
115	return true;
116	}
117
118	private GenAuditRoot getOrCreateRoot(GenAuditContainer auditContainer) {
119	GenAuditRoot result = auditContainer.getRoot();
120	if (result == null) {
121	result = GMFGenFactory.eINSTANCE.createGenAuditRoot();
122	result.getCategories().add(auditContainer);
123	}
124	return result;
125	}
126
127	}

Added Link Here

(-)src/org/eclipse/gmf/mappings/util/GMFMapMigrationHelper.java (+62 lines)
1	/*
2	* Copyright (c) 2007 Borland Software Corporation
3	*
4	* All rights reserved. This program and the accompanying materials are made
5	* available under the terms of the Eclipse Public License v1.0 which
6	* accompanies this distribution, and is available at
7	* http://www.eclipse.org/legal/epl-v10.html
8	*
9	* Contributors: Borland - initial API and implementation
10	*/
11	package org.eclipse.gmf.mappings.util;
12
13	import java.util.ArrayList;
14	import java.util.Collection;
15
16	import org.eclipse.emf.ecore.EObject;
17	import org.eclipse.gmf.internal.common.migrate.MigrationHelper;
18	import org.eclipse.gmf.mappings.FeatureLabelMapping;
19	import org.eclipse.gmf.mappings.GMFMapPackage;
20	import org.eclipse.gmf.mappings.LabelMapping;
21	import org.eclipse.gmf.mappings.MappingEntry;
22
23	public class GMFMapMigrationHelper extends MigrationHelper.MigrationHelperDelegateImpl {
24	private Collection<FeatureLabelMapping> myFeatureLabelMappings;
25
26	protected GMFMapMigrationHelper() {
27	super();
28	}
29
30	public void init() {
31	registerNarrowReferenceType(GMFMapPackage.eINSTANCE.getFeatureSeqInitializer_Initializers(), GMFMapPackage.eINSTANCE.getFeatureValueSpec());
32	registerNarrowReferenceType(GMFMapPackage.eINSTANCE.getMappingEntry_LabelMappings(), GMFMapPackage.eINSTANCE.getFeatureLabelMapping());
33	}
34
35	public void postProcess() {
36	for (FeatureLabelMapping mapping : getSavedFeatureLabelMappings()) {
37	if (mapping.getFeatures().isEmpty()) {
38	MappingEntry entry = mapping.getMapEntry();
39	entry.getLabelMappings().remove(mapping);
40	LabelMapping newMapping = GMFMapPackage.eINSTANCE.getGMFMapFactory().createLabelMapping();
41	newMapping.setDiagramLabel(mapping.getDiagramLabel());
42	if (mapping.isReadOnly()) {
43	newMapping.setReadOnly(true);
44	}
45	entry.getLabelMappings().add(newMapping);
46	}
47	}
48	}
49
50	public void processObject(EObject result) {
51	if (result instanceof FeatureLabelMapping) {
52	getSavedFeatureLabelMappings().add((FeatureLabelMapping) result);
53	}
54	}
55
56	private Collection<FeatureLabelMapping> getSavedFeatureLabelMappings() {
57	if (myFeatureLabelMappings == null) {
58	myFeatureLabelMappings = new ArrayList<FeatureLabelMapping>();
59	}
60	return myFeatureLabelMappings;
61	}
62	}

Lines 7-13 Link Here

(-)META-INF/MANIFEST.MF (-2 / +2 lines)
7	Export-Package: org.eclipse.gmf.common,	7	Export-Package: org.eclipse.gmf.common,
8	org.eclipse.gmf.common.codegen,	8	org.eclipse.gmf.common.codegen,
9	org.eclipse.gmf.internal.codegen.dispatch;x-friends:="org.eclipse.gmf.codegen,org.eclipse.gmf.graphdef.codegen,org.eclipse.gmf.codegen.lite",	9	org.eclipse.gmf.internal.codegen.dispatch;x-friends:="org.eclipse.gmf.codegen,org.eclipse.gmf.graphdef.codegen,org.eclipse.gmf.codegen.lite",
10	org.eclipse.gmf.internal.common;x-friends:="org.eclipse.gmf.codegen.edit,org.eclipse.gmf.graphdef.edit,org.eclipse.gmf.map.edit,org.eclipse.gmf.tooldef.edit,org.eclipse.gmf.bridge.trace,org.eclipse.gmf.bridge.ui,org.eclipse.gmf.bridge,org.eclipse.gmf.tests,org.eclipse.gmf.bridge.ui.dashboard,org.eclipse.gmf.codegen.ui,org.eclipse.gmf.codegen.lite.ui",	10	org.eclipse.gmf.internal.common;x-friends:="org.eclipse.gmf.codegen.edit,org.eclipse.gmf.graphdef.edit,org.eclipse.gmf.map.edit,org.eclipse.gmf.tooldef.edit,org.eclipse.gmf.bridge.trace,org.eclipse.gmf.bridge.ui,org.eclipse.gmf.bridge,org.eclipse.gmf.tests,org.eclipse.gmf.bridge.ui.dashboard,org.eclipse.gmf.codegen.ui,org.eclipse.gmf.codegen.lite.ui,org.eclipse.gmf.codegen,org.eclipse.gmf.map",
11	org.eclipse.gmf.internal.common.codegen;x-friends:="org.eclipse.gmf.codegen,org.eclipse.gmf.graphdef.codegen,org.eclipse.gmf.bridge,org.eclipse.gmf.codegen.lite,org.eclipse.gmf.tests,org.eclipse.gmf.codegen.ui,org.eclipse.gmf.codegen.lite.ui,org.eclipse.gmf.tests.lite,org.eclipse.gmf.graphdef.codegen.ui",	11	org.eclipse.gmf.internal.common.codegen;x-friends:="org.eclipse.gmf.codegen,org.eclipse.gmf.graphdef.codegen,org.eclipse.gmf.bridge,org.eclipse.gmf.codegen.lite,org.eclipse.gmf.tests,org.eclipse.gmf.codegen.ui,org.eclipse.gmf.codegen.lite.ui,org.eclipse.gmf.tests.lite,org.eclipse.gmf.graphdef.codegen.ui",
12	org.eclipse.gmf.internal.common.migrate;x-friends:="org.eclipse.gmf.codegen.ui,org.eclipse.gmf.tests,org.eclipse.gmf.codegen,org.eclipse.gmf.map,org.eclipse.gmf.bridge.ui",	12	org.eclipse.gmf.internal.common.migrate;x-friends:="org.eclipse.gmf.codegen.ui,org.eclipse.gmf.tests,org.eclipse.gmf.codegen,org.eclipse.gmf.map,org.eclipse.gmf.bridge.ui",
13	org.eclipse.gmf.internal.common.reconcile;x-friends:="org.eclipse.gmf.tests,org.eclipse.gmf.codegen,org.eclipse.gmf.bridge.ui",	13	org.eclipse.gmf.internal.common.reconcile;x-friends:="org.eclipse.gmf.tests,org.eclipse.gmf.codegen,org.eclipse.gmf.bridge.ui",
Lines 16-22 Link Here
16	org.eclipse.emf.common.ui;bundle-version="[2.3.0,3.0.0)",	16	org.eclipse.emf.common.ui;bundle-version="[2.3.0,3.0.0)",
17	org.eclipse.emf.codegen;bundle-version="[2.3.0,3.0.0)",	17	org.eclipse.emf.codegen;bundle-version="[2.3.0,3.0.0)",
18	org.eclipse.emf.codegen.ecore;bundle-version="[2.3.0,3.0.0)",	18	org.eclipse.emf.codegen.ecore;bundle-version="[2.3.0,3.0.0)",
19	org.eclipse.emf.ecore.xmi;bundle-version="[2.3.0,3.0.0)",	19	org.eclipse.emf.ecore.xmi;bundle-version="[2.3.0,3.0.0)";visibility:=reexport,
20	org.eclipse.core.resources;bundle-version="[3.3.0,4.0.0)";visibility:=reexport,	20	org.eclipse.core.resources;bundle-version="[3.3.0,4.0.0)";visibility:=reexport,
21	org.eclipse.ui.ide;bundle-version="[3.3.0,4.0.0)",	21	org.eclipse.ui.ide;bundle-version="[3.3.0,4.0.0)",
22	org.eclipse.ui.forms;bundle-version="[3.3.0,4.0.0)",	22	org.eclipse.ui.forms;bundle-version="[3.3.0,4.0.0)",

Lines 35-51 Link Here

(-)src/org/eclipse/gmf/internal/common/migrate/MigrationUtil.java (-5 / +9 lines)
35	* @return model-load-helper encapsulating the resource and its in-memory migrated contents.	35	* @return model-load-helper encapsulating the resource and its in-memory migrated contents.
36	*/	36	*/
37	public static ModelLoadHelper migrateModel(URI modelResourceURI) {	37	public static ModelLoadHelper migrateModel(URI modelResourceURI) {
		38	return migrateModel(new ToolingResourceFactory() {
		39	public Resource createResource(URI uri) {
		40	return new MigrationResource(uri);
		41	}
		42	}, modelResourceURI);
		43	}
		44
		45	public static ModelLoadHelper migrateModel(final Resource.Factory factory, URI modelResourceURI) {
38	if(modelResourceURI == null) {	46	if(modelResourceURI == null) {
39	throw new IllegalArgumentException("null resource uri"); //$NON-NLS-1$	47	throw new IllegalArgumentException("null resource uri"); //$NON-NLS-1$
40	}	48	}
41	ResourceSetImpl rset = new ResourceSetImpl();	49	ResourceSetImpl rset = new ResourceSetImpl();
42	rset.setResourceFactoryRegistry(new ResourceFactoryRegistryImpl() {	50	rset.setResourceFactoryRegistry(new ResourceFactoryRegistryImpl() {
43	public Factory getFactory(URI uri) {	51	public Factory getFactory(URI uri) {
44	return new ToolingResourceFactory() {	52	return factory;
45	public Resource createResource(URI uri) {
46	return new MigrationResource(uri);
47	}
48	};
49	}	53	}
50	});	54	});
51		55

Added Link Here

(-)src/org/eclipse/gmf/internal/common/migrate/MigrationResource2.java (+89 lines)
1	package org.eclipse.gmf.internal.common.migrate;
2
3	import java.io.IOException;
4	import java.io.InputStream;
5	import java.util.Collection;
6	import java.util.Map;
7
8	import org.eclipse.emf.common.util.URI;
9	import org.eclipse.emf.ecore.EPackage;
10	import org.eclipse.emf.ecore.xmi.XMLHelper;
11	import org.eclipse.emf.ecore.xmi.XMLLoad;
12	import org.eclipse.emf.ecore.xmi.impl.SAXXMIHandler;
13	import org.eclipse.emf.ecore.xmi.impl.XMILoadImpl;
14	import org.eclipse.gmf.internal.common.ToolingResourceFactory.ToolResource;
15	import org.xml.sax.helpers.DefaultHandler;
16
17	public abstract class MigrationResource2 extends ToolResource {
18
19	private boolean isOldVersionDetected;
20
21	protected MigrationResource2(URI uri) {
22	super(uri);
23	}
24
25	public final void doLoad(InputStream inputStream, Map<?,?> options) throws IOException {
26	try {
27	isOldVersionDetected = false;
28	super.doLoad(inputStream, options);
29	handlePostLoad();
30	} catch (IOException e) {
31	handlePostLoadException(e);
32	throw e;
33	} catch (RuntimeException e) {
34	handlePostLoadException(e);
35	throw e;
36	} finally {
37	isOldVersionDetected = false;
38	}
39	}
40
41	/*
42	* Create XMLLoad which handles old model migration at load-time
43	* @see org.eclipse.emf.ecore.xmi.impl.XMIResourceImpl#createXMLLoad()
44	*/
45	protected XMLLoad createXMLLoad() {
46	return new XMILoadImpl(createXMLHelper()) {
47
48	protected DefaultHandler makeDefaultHandler() {
49	return new SAXXMIHandler(resource, helper, options) {
50	protected EPackage getPackageForURI(String uriString) {
51	if(!getMetamodelNsURI().equals(uriString) &&
52	getBackwardSupportedURIs().contains(uriString)) {
53	handleOldVersionDetected();
54	return super.getPackageForURI(getMetamodelNsURI());
55	}
56	return super.getPackageForURI(uriString);
57	}
58	};
59	}
60	};
61	}
62
63	private void handleOldVersionDetected() {
64	isOldVersionDetected = true;
65	}
66
67	protected void handlePostLoad() {
68	if (isOldVersionDetected) {
69	// create warning only in case of old model loading
70	Diagnostic diagnostic = MigrationUtil.createMessageDiagnostic(this, Messages.oldModelVersionLoadedMigrationRequired);
71	getWarnings().add(0, diagnostic);
72	}
73	}
74
75	protected void handlePostLoadException(Exception e) {
76	Diagnostic diagnostic = MigrationUtil.createMessageDiagnostic(this, Messages.oldModelVersionLoadErrorMigrationMayBeRequired);
77	getErrors().add(0, diagnostic);
78	}
79
80	protected XMLHelper createXMLHelper() {
81	MigrationHelperDelegate delegate = createDelegate();
82	assert delegate != null;
83	return new MigrationHelper(this, delegate);
84	}
85
86	protected abstract String getMetamodelNsURI();
87	protected abstract Collection<String> getBackwardSupportedURIs();
88	protected abstract MigrationHelperDelegate createDelegate();
89	}