plugins/transformation/org.eclipse.papyrus.designer.transformation.extensions/src/org/eclipse/papyrus/designer/transformation/extensions/M2MTrafoExt.java

/*******************************************************************************
 * Copyright (c) 2011 CEA LIST.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     CEA LIST - initial API and implementation
 *******************************************************************************/

package org.eclipse.papyrus.designer.transformation.extensions;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.emf.common.util.EList;
import org.eclipse.papyrus.designer.transformation.base.utils.TransformationRTException;
import org.eclipse.papyrus.designer.transformation.profile.Transformation.ApplyTransformation;
import org.eclipse.papyrus.designer.transformation.profile.Transformation.M2MTrafo;
import org.eclipse.uml2.uml.Element;
import org.eclipse.uml2.uml.util.UMLUtil;


/**
 * Support for binding helper
 */
public class M2MTrafoExt {

	public static final String TRANSFORMATION_ID = "transformationID"; //$NON-NLS-1$
	public static final String M2M_TRAFO = Activator.PLUGIN_ID + ".m2mTrafo"; //$NON-NLS-1$

	/**
	 * Obtain a list of M2M transformations that are explicitly applied to a model element 
	 * @param element the model element
	 * @return the list of M2M transformations
	 */
	public static EList<M2MTrafo> getM2MTrafos(Element element) {
		ApplyTransformation applyTrafo =
				UMLUtil.getStereotypeApplication(element, ApplyTransformation.class);
		if (applyTrafo != null) {
			// execute the set of transformations applied to the element
			return applyTrafo.getTrafo();
		}
		return null;
	}
	
	/**
	 * Get a reference to the M2M transformation class using the m2mTrafo element (stereotype)
	 * if the kind option is set, the transformation class is obtained via the kind.
	 *
	 * @param m2mTrafo a m2m transformation reference
	 * @return a Java class reference
	 */
	public static IM2MTrafo getM2MTrafo(M2MTrafo m2mTrafo) {
		if (m2mTrafo != null) {
			return getM2MTrafo(m2mTrafo.getBase_Class().getQualifiedName());
		}
		return null;
	}

	/**
	 * Get a language specific M2M transformation from a generic one, provided that the following
	 * convention is applied: a language specific transformation is registered by appending the language
	 * name and :: as separator as transformation ID
	 * @param m2mTrafo a generic transformation
	 * @param language the name of a language, e.g. C++ or Java (as defined currently in the common languages.uml library)
	 * @return a language specific model library
	 */
	public static IM2MTrafo getM2MTrafoForLanguage(M2MTrafo m2mTrafo, String language) {
		return M2MTrafoExt.getM2MTrafo(String.format("%s::%s", m2mTrafo.getBase_Class().getQualifiedName(), language)); //$NON-NLS-1$
	}
	
	/**
	 * Get a transformation by passing the transformation ID
	 * @param trafoID the ID of a registered transformation, typically the qualified name of the associated model element
	 * @return the transformation, if it exists, null otherwise
	 */
	public static IM2MTrafo getM2MTrafo(String trafoID) {
		IExtensionRegistry reg = Platform.getExtensionRegistry();
		IConfigurationElement[] configElements = reg.getConfigurationElementsFor(M2M_TRAFO);
		for (IConfigurationElement configElement : configElements) {
			try {
				final String transformationID = configElement.getAttribute(TRANSFORMATION_ID);
				if ((transformationID != null) && transformationID.equals(trafoID)) {
					final Object obj = configElement.createExecutableExtension("class"); //$NON-NLS-1$
					if (obj instanceof IM2MTrafo) {
						return (IM2MTrafo) obj;
					}
				}
			} catch (CoreException exception) {
				Activator.log.error(exception);
			}
		}
		throw new TransformationRTException(
				String.format(Messages.M2MTrafoExt_NoClassForTransformation, trafoID));
	}
}