Diagram.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.editor;

import org.eclipse.jface.viewers.IStructuredSelection;

import edu.toronto.cs.se.mmint.MMINTException;
import edu.toronto.cs.se.mmint.mid.MID;
import edu.toronto.cs.se.mmint.mid.ui.EditorCreationWizardDialog;


/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Diagram</b></em>'.
 * <!-- end-user-doc -->
 *
 * <!-- begin-model-doc -->
 * A diagram type or a diagram instance.
 * <!-- end-model-doc -->
 *
 *
 * @see edu.toronto.cs.se.mmint.mid.editor.EditorPackage#getDiagram()
 * @model
 * @generated
 */
public interface Diagram extends Editor {

	/**
	 * <!-- begin-user-doc --> Creates and adds a subtype of this diagram type
	 * to the Type MID.
	 * 
	 * @param newEditorTypeFragmentUri
	 *            The uri fragment to be appended as part of the uri of the new
	 *            diagram type.
	 * @param newEditorTypeName
	 *            The name of the new diagram type.
	 * @param modelTypeUri
	 *            The uri of the model type handled by the new diagram type.
	 * @param editorId
	 *            The id of the corresponding Eclipse editor.
	 * @param wizardId
	 *            The wizard id of the corresponding Eclipse editor.
	 * @param wizardDialogClassName
	 *            The fully qualified name of a Java class that handles the
	 *            creation of the model type through the new diagram type.
	 * @return The created editor type.
	 * @throws MMINTException
	 *             If this is a diagram instance, or if the uri of the new
	 *             diagram type is already registered in the Type MID.
	 *             <!-- end-user-doc -->
	 * @model required="true" exceptions="edu.toronto.cs.se.mmint.mid.MMINTException" newEditorTypeFragmentUriRequired="true" newEditorTypeNameRequired="true" modelTypeUriRequired="true" editorIdRequired="true" wizardIdRequired="true" wizardDialogClassNameRequired="true"
	 * @generated
	 */
	Editor createSubtype(String newEditorTypeFragmentUri, String newEditorTypeName, String modelTypeUri, String editorId, String wizardId, String wizardDialogClassName) throws MMINTException;

	/**
	 * <!-- begin-user-doc --> Creates and adds a diagram instance of this
	 * diagram type to an Instance MID.
	 * 
	 * @param modelUri
	 *            The uri of the model handled by the new diagram.
	 * @param instanceMID
	 *            An Instance MID.
	 * @return The created diagram.
	 * @throws MMINTException
	 *             If this is a diagram instance, or if the diagram couldn't be
	 *             created. <!-- end-user-doc -->
	 * @model required="true" exceptions="edu.toronto.cs.se.mmint.mid.MMINTException" modelUriRequired="true" instanceMIDRequired="true"
	 * @generated
	 */
	Editor createInstance(String modelUri, MID instanceMID) throws MMINTException;

	/**
	 * <!-- begin-user-doc --> Invokes a diagram instance creation wizard for
	 * this diagram type. The wizard can be initialized with an existing model,
	 * or create the underlying model as a side effect.
	 * 
	 * @param initialSelection
	 *            The selection used to initialize the wizard. It can be an
	 *            existing model file, or its container when the underlying
	 *            model file has to be created.
	 * @return The diagram creation wizard dialog, null if the user canceled the
	 *         operation.
	 * @throws MMINTException
	 *             If this is a diagram instance, or if the diagram creation
	 *             wizard could not be invoked. <!-- end-user-doc -->
	 * @model dataType="edu.toronto.cs.se.mmint.mid.editor.EditorCreationWizardDialog" required="true" exceptions="edu.toronto.cs.se.mmint.mid.MMINTException" initialSelectionDataType="edu.toronto.cs.se.mmint.mid.editor.IStructuredSelection" initialSelectionRequired="true"
	 * @generated
	 */
	EditorCreationWizardDialog invokeInstanceWizard(IStructuredSelection initialSelection) throws MMINTException;

} // Diagram