org.eclipse.osbp.vaaclipse.addons.common.api/src/org/eclipse/osbp/vaaclipse/addons/common/api/model/VaaclipseModelUtils.java - osbp/org.eclipse.osbp.vaaclipse.addons.common.api - Git at Google

 /*******************************************************************************
  * Copyright (c) 2010, 2013 IBM Corporation and others.
  * 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:
  *     IBM Corporation - initial API and implementation
  *     René Brandstetter - Bug 411821 - [QuickAccess] Contribute SearchField
  *                                      through a fragment or other means
  *	   Florian Pirchner - adjusted for Vaaclipse perspectives restore
  *******************************************************************************/
 package org.eclipse.osbp.vaaclipse.addons.common.api.model;

 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;

 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.eclipse.e4.ui.internal.workbench.E4XMIResource;
 import org.eclipse.e4.ui.model.application.MApplicationElement;
 import org.eclipse.e4.ui.model.application.ui.MContext;
 import org.eclipse.e4.ui.model.application.ui.MUIElement;
 import org.eclipse.e4.ui.model.internal.Position;
 import org.eclipse.e4.ui.model.internal.PositionInfo;
 import org.eclipse.emf.common.util.EList;
 import org.eclipse.emf.common.util.TreeIterator;
 import org.eclipse.emf.ecore.EClass;
 import org.eclipse.emf.ecore.EClassifier;
 import org.eclipse.emf.ecore.EGenericType;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.EStructuralFeature;
 import org.eclipse.emf.ecore.EStructuralFeature.Setting;
 import org.eclipse.emf.ecore.ETypeParameter;
 import org.eclipse.emf.ecore.util.EcoreUtil;
 import org.eclipse.emf.ecore.util.EcoreUtil.UsageCrossReferencer;
 import org.eclipse.emf.ecore.xmi.XMLResource;

 /**
  * The Class VaaclipseModelUtils.
  */
 @SuppressWarnings("restriction")
 public class VaaclipseModelUtils {
 	// public static final String CONTAINING_CONTEXT =
 	/** The Constant CONTAINING_PARENT. */
 	// "ModelUtils.containingContext";
 	public static final String CONTAINING_PARENT = "ModelUtils.containingParent";

 	/**
 	 * Gets the type argument.
 	 *
 	 * @param eClass
 	 *            the e class
 	 * @param eGenericType
 	 *            the e generic type
 	 * @return the type argument
 	 */
 	public static EClassifier getTypeArgument(EClass eClass,
 			EGenericType eGenericType) {
 		ETypeParameter eTypeParameter = eGenericType.getETypeParameter();

 		if (eTypeParameter != null) {
 			for (EGenericType eGenericSuperType : eClass
 					.getEAllGenericSuperTypes()) {
 				EList<ETypeParameter> eTypeParameters = eGenericSuperType
 						.getEClassifier().getETypeParameters();
 				int index = eTypeParameters.indexOf(eTypeParameter);
 				if (index != -1
 						&& eGenericSuperType.getETypeArguments().size() > index) {
 					return getTypeArgument(eClass, eGenericSuperType
 							.getETypeArguments().get(index));
 				}
 			}
 			return null;
 		} else {
 			return eGenericType.getEClassifier();
 		}
 	}

 	/**
 	 * Find element by id.
 	 *
 	 * @param element
 	 *            the element
 	 * @param id
 	 *            the id
 	 * @return the m application element
 	 */
 	public static MApplicationElement findElementById(
 			MApplicationElement element, String id) {
 		if (id == null || id.length() == 0) {
 			return null;
 		}
 		// is it me?
 		if (id.equals(element.getElementId())) {
 			return element;
 		}
 		// Recurse if this is a container
 		EList<EObject> elements = ((EObject) element).eContents();
 		for (EObject childElement : elements) {
 			if (!(childElement instanceof MApplicationElement)) {
 				continue;
 			}
 			MApplicationElement result = findElementById(
 					(MApplicationElement) childElement, id);
 			if (result != null) {
 				return result;
 			}
 		}
 		return null;
 	}

 	/**
 	 * Merge.
 	 *
 	 * @param container
 	 *            the container
 	 * @param feature
 	 *            the feature
 	 * @param elements
 	 *            the elements
 	 * @param positionInList
 	 *            the position in list
 	 * @return the list
 	 */
 	@SuppressWarnings("unchecked")
 	public static List<MApplicationElement> merge(
 			MApplicationElement container, EStructuralFeature feature,
 			List<MApplicationElement> elements, String positionInList) {
 		EObject eContainer = (EObject) container;

 		if (feature.isMany()) {
 			List<MApplicationElement> copy = new ArrayList<MApplicationElement>(
 					elements);

 			List<Object> list = (List<Object>) eContainer.eGet(feature);
 			boolean flag = true;
 			if (positionInList != null && positionInList.trim().length() != 0) {
 				int index = -1;

 				PositionInfo posInfo = PositionInfo.parse(positionInList);

 				if (posInfo != null) {
 					switch (posInfo.getPosition()) {
 					case FIRST:
 						index = 0;
 						break;

 					case INDEX:
 						index = posInfo.getPositionReferenceAsInteger();
 						break;

 					case BEFORE:
 					case AFTER:
 						int tmpIndex = -1;
 						String elementId = posInfo.getPositionReference();

 						for (int i = 0; i < list.size(); i++) {
 							if (elementId.equals(((MApplicationElement) list
 									.get(i)).getElementId())) {
 								tmpIndex = i;
 								break;
 							}
 						}

 						if (tmpIndex != -1) {
 							if (posInfo.getPosition() == Position.BEFORE) {
 								index = tmpIndex;
 							} else {
 								index = tmpIndex + 1;
 							}
 						} else {
 							System.err
 									.println("Could not find element with Id '"
 											+ elementId + "'");
 						}

 					case LAST:
 					default:
 						// both no special operation, because the default is
 						// adding it at the last position
 						break;
 					}
 				} else {
 					System.err.println("Not a valid list position.");
 				}

 				if (index >= 0 && list.size() > index) {
 					flag = false;
 					mergeList(list, elements, index);
 				}
 			}

 			// If there was no match append it to the list
 			if (flag) {
 				mergeList(list, elements, -1);
 			}

 			return copy;
 		} else {
 			if (elements.size() >= 1) {
 				if (elements.size() > 1) {
 					// FIXME Pass the logger
 					System.err
 							.println("The feature is single valued but a list of values is passed in.");
 				}
 				MApplicationElement e = elements.get(0);
 				eContainer.eSet(feature, e);
 				return Collections.singletonList(e);
 			}
 		}

 		return Collections.emptyList();
 	}

 	/**
 	 * Merge list.
 	 *
 	 * @param list
 	 *            the list
 	 * @param elements
 	 *            the elements
 	 * @param index
 	 *            the index
 	 */
 	private static void mergeList(List<Object> list,
 			List<MApplicationElement> elements, int index) {
 		MApplicationElement[] tmp = new MApplicationElement[elements.size()];
 		elements.toArray(tmp);
 		for (MApplicationElement element : tmp) {
 			String elementID = element.getElementId();
 			boolean found = false;
 			if ((elementID != null) && (elementID.length() != 0)) {
 				for (Object existingObject : list) {
 					if (!(existingObject instanceof MApplicationElement)) {
 						continue;
 					}
 					MApplicationElement existingEObject = (MApplicationElement) existingObject;
 					if (!elementID.equals(existingEObject.getElementId())) {
 						continue;
 					}
 					if (EcoreUtil.equals((EObject) existingEObject,
 							(EObject) element)) {
 						found = true; // skip
 						break;
 					} else { // replace
 						EObject root = EcoreUtil
 								.getRootContainer((EObject) existingEObject);

 						// Set the old element id to the new element
 						//
 						XMLResource existingResource = (XMLResource) ((EObject) existingEObject)
 								.eResource();
 						// Set id for root
 						String id = existingResource
 								.getID((EObject) existingEObject);
 						existingResource.setID((EObject) element, id);

 						// Remember IDs of subitems
 						TreeIterator<EObject> treeIt = EcoreUtil
 								.getAllContents((EObject) element, true);
 						while (treeIt.hasNext()) {
 							EObject eObj = treeIt.next();
 							E4XMIResource r = (E4XMIResource) eObj.eResource();
 							existingResource.setID(eObj, r.getID(eObj));
 						}

 						EcoreUtil.replace((EObject) existingEObject,
 								(EObject) element);

 						// Replacing the object in other references than the
 						// container.
 						Collection<Setting> settings = UsageCrossReferencer
 								.find((EObject) existingEObject, root);
 						for (Setting setting : settings) {
 							if(setting instanceof List) {
 								setting.set(Collections.singletonList(element));
 							}else {
 								setting.set(element);
 							}
 						}
 						found = true;
 					}
 				}
 			}
 			if (!found) {
 				if (index == -1) {
 					list.add(element);
 				} else {
 					list.add(index, element);
 				}
 			}
 		}
 	}

 	/**
 	 * Gets the parent.
 	 *
 	 * @param element
 	 *            the element
 	 * @return the parent
 	 */
 	static MApplicationElement getParent(MApplicationElement element) {
 		if ((element instanceof MUIElement)
 				&& ((MUIElement) element).getCurSharedRef() != null) {
 			return ((MUIElement) element).getCurSharedRef().getParent();
 		} else if (element.getTransientData().get(CONTAINING_PARENT) instanceof MApplicationElement) {
 			return (MApplicationElement) element.getTransientData().get(
 					CONTAINING_PARENT);
 		} else if (element instanceof EObject) {
 			return (MApplicationElement) ((EObject) element).eContainer();
 		}
 		return null;
 	}

 	/**
 	 * Gets the containing context.
 	 *
 	 * @param element
 	 *            the element
 	 * @return the containing context
 	 */
 	public static IEclipseContext getContainingContext(
 			MApplicationElement element) {
 		MApplicationElement curParent = getParent(element);

 		while (curParent != null) {
 			if (curParent instanceof MContext) {
 				return ((MContext) curParent).getContext();
 			}
 			curParent = getParent(curParent);
 		}

 		return null;
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2010, 2013 IBM Corporation and others.
	* 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:
	* IBM Corporation - initial API and implementation
	* René Brandstetter - Bug 411821 - [QuickAccess] Contribute SearchField
	* through a fragment or other means
	* Florian Pirchner - adjusted for Vaaclipse perspectives restore
	*******************************************************************************/
	package org.eclipse.osbp.vaaclipse.addons.common.api.model;

	import java.util.ArrayList;
	import java.util.Collection;
	import java.util.Collections;
	import java.util.List;

	import org.eclipse.e4.core.contexts.IEclipseContext;
	import org.eclipse.e4.ui.internal.workbench.E4XMIResource;
	import org.eclipse.e4.ui.model.application.MApplicationElement;
	import org.eclipse.e4.ui.model.application.ui.MContext;
	import org.eclipse.e4.ui.model.application.ui.MUIElement;
	import org.eclipse.e4.ui.model.internal.Position;
	import org.eclipse.e4.ui.model.internal.PositionInfo;
	import org.eclipse.emf.common.util.EList;
	import org.eclipse.emf.common.util.TreeIterator;
	import org.eclipse.emf.ecore.EClass;
	import org.eclipse.emf.ecore.EClassifier;
	import org.eclipse.emf.ecore.EGenericType;
	import org.eclipse.emf.ecore.EObject;
	import org.eclipse.emf.ecore.EStructuralFeature;
	import org.eclipse.emf.ecore.EStructuralFeature.Setting;
	import org.eclipse.emf.ecore.ETypeParameter;
	import org.eclipse.emf.ecore.util.EcoreUtil;
	import org.eclipse.emf.ecore.util.EcoreUtil.UsageCrossReferencer;
	import org.eclipse.emf.ecore.xmi.XMLResource;

	/**
	* The Class VaaclipseModelUtils.
	*/
	@SuppressWarnings("restriction")
	public class VaaclipseModelUtils {
	// public static final String CONTAINING_CONTEXT =
	/** The Constant CONTAINING_PARENT. */
	// "ModelUtils.containingContext";
	public static final String CONTAINING_PARENT = "ModelUtils.containingParent";

	/**
	* Gets the type argument.
	*
	* @param eClass
	* the e class
	* @param eGenericType
	* the e generic type
	* @return the type argument
	*/
	public static EClassifier getTypeArgument(EClass eClass,
	EGenericType eGenericType) {
	ETypeParameter eTypeParameter = eGenericType.getETypeParameter();

	if (eTypeParameter != null) {
	for (EGenericType eGenericSuperType : eClass
	.getEAllGenericSuperTypes()) {
	EList<ETypeParameter> eTypeParameters = eGenericSuperType
	.getEClassifier().getETypeParameters();
	int index = eTypeParameters.indexOf(eTypeParameter);
	if (index != -1
	&& eGenericSuperType.getETypeArguments().size() > index) {
	return getTypeArgument(eClass, eGenericSuperType
	.getETypeArguments().get(index));
	}
	}
	return null;
	} else {
	return eGenericType.getEClassifier();
	}
	}

	/**
	* Find element by id.
	*
	* @param element
	* the element
	* @param id
	* the id
	* @return the m application element
	*/
	public static MApplicationElement findElementById(
	MApplicationElement element, String id) {
	if (id == null \|\| id.length() == 0) {
	return null;
	}
	// is it me?
	if (id.equals(element.getElementId())) {
	return element;
	}
	// Recurse if this is a container
	EList<EObject> elements = ((EObject) element).eContents();
	for (EObject childElement : elements) {
	if (!(childElement instanceof MApplicationElement)) {
	continue;
	}
	MApplicationElement result = findElementById(
	(MApplicationElement) childElement, id);
	if (result != null) {
	return result;
	}
	}
	return null;
	}

	/**
	* Merge.
	*
	* @param container
	* the container
	* @param feature
	* the feature
	* @param elements
	* the elements
	* @param positionInList
	* the position in list
	* @return the list
	*/
	@SuppressWarnings("unchecked")
	public static List<MApplicationElement> merge(
	MApplicationElement container, EStructuralFeature feature,
	List<MApplicationElement> elements, String positionInList) {
	EObject eContainer = (EObject) container;

	if (feature.isMany()) {
	List<MApplicationElement> copy = new ArrayList<MApplicationElement>(
	elements);

	List<Object> list = (List<Object>) eContainer.eGet(feature);
	boolean flag = true;
	if (positionInList != null && positionInList.trim().length() != 0) {
	int index = -1;

	PositionInfo posInfo = PositionInfo.parse(positionInList);

	if (posInfo != null) {
	switch (posInfo.getPosition()) {
	case FIRST:
	index = 0;
	break;

	case INDEX:
	index = posInfo.getPositionReferenceAsInteger();
	break;

	case BEFORE:
	case AFTER:
	int tmpIndex = -1;
	String elementId = posInfo.getPositionReference();

	for (int i = 0; i < list.size(); i++) {
	if (elementId.equals(((MApplicationElement) list
	.get(i)).getElementId())) {
	tmpIndex = i;
	break;
	}
	}

	if (tmpIndex != -1) {
	if (posInfo.getPosition() == Position.BEFORE) {
	index = tmpIndex;
	} else {
	index = tmpIndex + 1;
	}
	} else {
	System.err
	.println("Could not find element with Id '"
	+ elementId + "'");
	}

	case LAST:
	default:
	// both no special operation, because the default is
	// adding it at the last position
	break;
	}
	} else {
	System.err.println("Not a valid list position.");
	}

	if (index >= 0 && list.size() > index) {
	flag = false;
	mergeList(list, elements, index);
	}
	}

	// If there was no match append it to the list
	if (flag) {
	mergeList(list, elements, -1);
	}

	return copy;
	} else {
	if (elements.size() >= 1) {
	if (elements.size() > 1) {
	// FIXME Pass the logger
	System.err
	.println("The feature is single valued but a list of values is passed in.");
	}
	MApplicationElement e = elements.get(0);
	eContainer.eSet(feature, e);
	return Collections.singletonList(e);
	}
	}

	return Collections.emptyList();
	}

	/**
	* Merge list.
	*
	* @param list
	* the list
	* @param elements
	* the elements
	* @param index
	* the index
	*/
	private static void mergeList(List<Object> list,
	List<MApplicationElement> elements, int index) {
	MApplicationElement[] tmp = new MApplicationElement[elements.size()];
	elements.toArray(tmp);
	for (MApplicationElement element : tmp) {
	String elementID = element.getElementId();
	boolean found = false;
	if ((elementID != null) && (elementID.length() != 0)) {
	for (Object existingObject : list) {
	if (!(existingObject instanceof MApplicationElement)) {
	continue;
	}
	MApplicationElement existingEObject = (MApplicationElement) existingObject;
	if (!elementID.equals(existingEObject.getElementId())) {
	continue;
	}
	if (EcoreUtil.equals((EObject) existingEObject,
	(EObject) element)) {
	found = true; // skip
	break;
	} else { // replace
	EObject root = EcoreUtil
	.getRootContainer((EObject) existingEObject);

	// Set the old element id to the new element
	//
	XMLResource existingResource = (XMLResource) ((EObject) existingEObject)
	.eResource();
	// Set id for root
	String id = existingResource
	.getID((EObject) existingEObject);
	existingResource.setID((EObject) element, id);

	// Remember IDs of subitems
	TreeIterator<EObject> treeIt = EcoreUtil
	.getAllContents((EObject) element, true);
	while (treeIt.hasNext()) {
	EObject eObj = treeIt.next();
	E4XMIResource r = (E4XMIResource) eObj.eResource();
	existingResource.setID(eObj, r.getID(eObj));
	}

	EcoreUtil.replace((EObject) existingEObject,
	(EObject) element);

	// Replacing the object in other references than the
	// container.
	Collection<Setting> settings = UsageCrossReferencer
	.find((EObject) existingEObject, root);
	for (Setting setting : settings) {
	if(setting instanceof List) {
	setting.set(Collections.singletonList(element));
	}else {
	setting.set(element);
	}
	}
	found = true;
	}
	}
	}
	if (!found) {
	if (index == -1) {
	list.add(element);
	} else {
	list.add(index, element);
	}
	}
	}
	}

	/**
	* Gets the parent.
	*
	* @param element
	* the element
	* @return the parent
	*/
	static MApplicationElement getParent(MApplicationElement element) {
	if ((element instanceof MUIElement)
	&& ((MUIElement) element).getCurSharedRef() != null) {
	return ((MUIElement) element).getCurSharedRef().getParent();
	} else if (element.getTransientData().get(CONTAINING_PARENT) instanceof MApplicationElement) {
	return (MApplicationElement) element.getTransientData().get(
	CONTAINING_PARENT);
	} else if (element instanceof EObject) {
	return (MApplicationElement) ((EObject) element).eContainer();
	}
	return null;
	}

	/**
	* Gets the containing context.
	*
	* @param element
	* the element
	* @return the containing context
	*/
	public static IEclipseContext getContainingContext(
	MApplicationElement element) {
	MApplicationElement curParent = getParent(element);

	while (curParent != null) {
	if (curParent instanceof MContext) {
	return ((MContext) curParent).getContext();
	}
	curParent = getParent(curParent);
	}

	return null;
	}
	}