ModelEndpointReferenceImportModelCommand.java

/**
 * Copyright (c) 2012-2016 Marsha Chechik, Alessio Di Sandro, Michalis Famelis,
 * Rick Salay.
 * 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:
 *    Alessio Di Sandro - Implementation.
 */
package edu.toronto.cs.se.mmint.mid.relationship.diagram.edit.commands;

import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.gmf.runtime.common.core.command.CommandResult;
import org.eclipse.gmf.runtime.emf.type.core.requests.CreateElementRequest;

import edu.toronto.cs.se.mmint.MMINTException;
import edu.toronto.cs.se.mmint.mid.relationship.BinaryModelRel;
import edu.toronto.cs.se.mmint.mid.relationship.ModelEndpointReference;
import edu.toronto.cs.se.mmint.mid.relationship.ModelRel;

/**
 * The command to create a model reference by importing an existing model.
 * 
 * @author Alessio Di Sandro
 * 
 */
public class ModelEndpointReferenceImportModelCommand extends ModelEndpointReferenceCreateCommand {

	/**
	 * Constructor: initialises the superclass.
	 * 
	 * @param req
	 *            The request.
	 */
	public ModelEndpointReferenceImportModelCommand(CreateElementRequest req) {

		super(req);
	}

	/**
	 * Checks if a model reference can be imported. In the INSTANCES case,
	 * disallows the command to be executed when the diagram root is a binary
	 * model relationship and is either not standalone or has already two
	 * models.
	 * 
	 * @return True if a model reference can be imported, false otherwise.
	 */
	@Override
	public boolean canExecute() {

		ModelRel modelRel = (ModelRel) getElementToEdit();
		if (!modelRel.isInstancesLevel()) {
			return false;
		}
		if (modelRel instanceof BinaryModelRel) {
			// a binary relationship which is not standalone can be only modified through the mid diagram
			// a binary relationship which is standalone must have at most 2 models
			if (modelRel.getMIDContainer() != null || modelRel.getModelEndpoints().size() >= 2) {
				return false;
			}
		}

		return super.canExecute();
	}

	protected ModelEndpointReference doExecuteInstancesLevel() throws Exception{

		//TODO MMINT[MID] completely review this whole class, now we don't just import a model, we can also add an endpoint to the same model
//		String modelUri = MultiModelDiagramUtils.selectModelToImport(false);
//		ModelRel owner = (ModelRel) getElementToEdit();
//		Model newModel;
//
//		MultiModelInstanceFactory.assertModelUnique(owner, modelUri); // model must not be already in the mapping
//		if (owner.eContainer() == null) { // standalone mapping reference
//			newModel = MultiModelInstanceFactory.createModel(null, ModelOrigin.IMPORTED, null, modelUri);
//		}
//		else {
//			newModel = MultiModelInstanceFactory.getModelUnique((MultiModel) owner.eContainer(), modelUri); // model can be already in the MID
//			if (newModel == null) {
//				newModel = MultiModelInstanceFactory.createModel(null, ModelOrigin.IMPORTED, (MultiModel) owner.eContainer(), modelUri);
//				Editor editor = MultiModelInstanceFactory.createEditor(newModel);
//				if (editor != null) {
//					MultiModelInstanceFactory.addModelEditor(editor, (MultiModel) owner.eContainer());
//				}
//			}
//		}
//		EList<String> modelTypeEndpointUris = MultiModelConstraintChecker.getAllowedModelEndpoints(owner, (Model) newModel);
//		ModelEndpointReference modelTypeEndpointRef = RelationshipDiagramUtils.selectModelTypeEndpointToCreate(owner, modelTypeEndpointUris, "");
//		ModelEndpointReference newModelEndpointRef = MultiModelInstanceFactory.createModelEndpointAndModelEndpointReference(
//			modelTypeEndpointRef.getObject(),
//			owner,
//			newModel,
//			false
//		);
//
//		// update outline
//		MidDiagramEditor editor = (MidDiagramEditor) PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().getActiveEditor();
//		editor.getOutlinePage().addInput(modelUri);
//
//		return newModelEndpointRef;
		return null;
	}

	/**
	 * Creates a new model reference by importing a model.
	 * 
	 * @param monitor
	 *            The progress monitor.
	 * @param info
	 *            Additional parameter, not used.
	 * @return The ok result, or the error result if the model could not be
	 *         imported.
	 * @throws ExecutionException
	 *             If configuration command execution goes wrong.
	 */
	@Override
	protected CommandResult doExecuteWithResult(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {

		try {
			ModelEndpointReference newElement;
			switch (((ModelRel) getElementToEdit()).getLevel()) {
				case TYPES:
					throw new MMINTException("The TYPES level is not allowed");
				case INSTANCES:
					newElement = this.doExecuteInstancesLevel();
					break;
				case WORKFLOWS:
					throw new MMINTException("The WORKFLOWS level is not allowed");
				default:
					throw new MMINTException("The MID level is missing");
			}
			doConfigure(newElement, monitor, info);
			((CreateElementRequest) getRequest()).setNewElement(newElement);

			return CommandResult.newOKCommandResult(newElement);
		}
		catch (ExecutionException ee) {
			throw ee;
		}
		catch (Exception e) {
			MMINTException.print(IStatus.ERROR, "No model imported", e);
			return CommandResult.newErrorCommandResult("No model imported");
		}
	}

}