CreateConnectionViewAndElementRequest.java

/******************************************************************************
 * Copyright (c) 2002, 2008 IBM Corporation and others.
 * 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:
 *    IBM Corporation - initial API and implementation 
 ****************************************************************************/

package org.eclipse.gmf.runtime.diagram.ui.requests;

import java.util.Map;

import org.eclipse.core.runtime.Assert;
import org.eclipse.gef.EditPart;
import org.eclipse.gef.commands.Command;
import org.eclipse.gmf.runtime.diagram.core.edithelpers.CreateElementRequestAdapter;
import org.eclipse.gmf.runtime.diagram.core.preferences.PreferencesHint;
import org.eclipse.gmf.runtime.diagram.ui.internal.requests.SuppressibleUIRequest;
import org.eclipse.gmf.runtime.emf.type.core.IElementType;
import org.eclipse.gmf.runtime.emf.type.core.requests.CreateElementRequest;
import org.eclipse.gmf.runtime.emf.type.core.requests.CreateRelationshipRequest;

/**
 * @author melaasar
 * 
 * A request to create a relationship element and its connection view
 */
public class CreateConnectionViewAndElementRequest
	extends CreateConnectionViewRequest
	implements SuppressibleUIRequest {

	private boolean suppressUI = false;

	/**
	 * @return true if the command will suppress all ui prompting and just use
	 *         default data
	 */
	public boolean isUISupressed() {

		return suppressUI;
	}

	/**
	 * @param suppressUI
	 *            true if you do not wish the command to prompt with UI but
	 *            instead take the default value that it would have prompt for.
	 */
	public void setSuppressibleUI(boolean suppressUI) {
		this.suppressUI = suppressUI;

	}

	/**
	 * An extended view descriptor that takes an <code>ElementDescriptor</code>
	 * instead of <code>IAdaptable</code> as the element adapter
	 */
	public static class ConnectionViewAndElementDescriptor
		extends ConnectionViewDescriptor {

		/**
		 * Constructor.
		 * 
		 * @param requestAdapter
		 * @param preferencesHint
		 *            The preference hint that is to be used to find the
		 *            appropriate preference store from which to retrieve
		 *            diagram preference values. The preference hint is mapped
		 *            to a preference store in the preference registry <@link
		 *            DiagramPreferencesRegistry>.
		 */
		public ConnectionViewAndElementDescriptor(
				CreateElementRequestAdapter requestAdapter,
				PreferencesHint preferencesHint) {
			super(requestAdapter, preferencesHint);
		}

		/**
		 * Constructor.
		 * 
		 * @param requestAdapter
		 * @param semanticHint
		 * @param preferencesHint
		 *            The preference hint that is to be used to find the
		 *            appropriate preference store from which to retrieve
		 *            diagram preference values. The preference hint is mapped
		 *            to a preference store in the preference registry <@link
		 *            DiagramPreferencesRegistry>.
		 */
		public ConnectionViewAndElementDescriptor(
				CreateElementRequestAdapter requestAdapter,
				String semanticHint, PreferencesHint preferencesHint) {
			super(requestAdapter, semanticHint, preferencesHint);
		}

		/**
		 * Constructor.
		 * 
		 * @param requestAdapter
		 * @param semanticHint
		 * @param index
		 * @param preferencesHint
		 *            The preference hint that is to be used to find the
		 *            appropriate preference store from which to retrieve
		 *            diagram preference values. The preference hint is mapped
		 *            to a preference store in the preference registry <@link
		 *            DiagramPreferencesRegistry>.
		 */
		public ConnectionViewAndElementDescriptor(
				CreateElementRequestAdapter requestAdapter,
				String semanticHint, int index, PreferencesHint preferencesHint) {
			super(requestAdapter, semanticHint, index, preferencesHint);
		}

		/**
		 * Method getElementDescriptor.
		 * 
		 * @return ElementDescriptor
		 */
		public CreateElementRequestAdapter getCreateElementRequestAdapter() {
			return (CreateElementRequestAdapter) getElementAdapter();
		}

	}

	/**
	 * Constructor.
	 * 
	 * @param connectionViewAndElementDescriptor
	 */
	public CreateConnectionViewAndElementRequest(
			ConnectionViewAndElementDescriptor connectionViewAndElementDescriptor) {
		super(connectionViewAndElementDescriptor);
	}

	/**
	 * Constructor.
	 * 
	 * @param type
	 * @param semanticHint
	 * @param preferencesHint
	 *            The preference hint that is to be used to find the appropriate
	 *            preference store from which to retrieve diagram preference
	 *            values. The preference hint is mapped to a preference store in
	 *            the preference registry <@link DiagramPreferencesRegistry>.
	 */
	public CreateConnectionViewAndElementRequest(IElementType type,
			String semanticHint, PreferencesHint preferencesHint) {
		super(
			new ConnectionViewAndElementDescriptor(
				new CreateElementRequestAdapter(new CreateRelationshipRequest(
					type)), semanticHint, preferencesHint));
	}

	/**
	 * Constructor.
	 * 
	 * @param type
	 * @param preferencesHint
	 *            The preference hint that is to be used to find the appropriate
	 *            preference store from which to retrieve diagram preference
	 *            values. The preference hint is mapped to a preference store in
	 *            the preference registry <@link DiagramPreferencesRegistry>.
	 */
	public CreateConnectionViewAndElementRequest(IElementType type,
			PreferencesHint preferencesHint) {
		super(
			new ConnectionViewAndElementDescriptor(
				new CreateElementRequestAdapter(new CreateRelationshipRequest(
					type)), preferencesHint));
	}

	/**
	 * Gets the descriptor for the connection view and element that is to be
	 * created.
	 * 
	 * @return the descriptor
	 */
	public ConnectionViewAndElementDescriptor getConnectionViewAndElementDescriptor() {
		return (ConnectionViewAndElementDescriptor) getConnectionViewDescriptor();
	}

	/**
	 * Method getCreateCommand. TODO: remove after msl migration
	 * 
	 * @param request
	 * @param sourceEditPart
	 * @param targetEditPart
	 * @return Command
	 */
	public static Command getCreateCommand(
			CreateConnectionViewAndElementRequest request,
			EditPart sourceEditPart, EditPart targetEditPart) {

		Assert.isNotNull(request);
		Assert.isNotNull(sourceEditPart);
		Assert.isNotNull(targetEditPart);

		request.setSourceEditPart(sourceEditPart);
		request.setTargetEditPart(targetEditPart);
		request.setType(RequestConstants.REQ_CONNECTION_START);
		sourceEditPart.getCommand(request);
		request.setType(RequestConstants.REQ_CONNECTION_END);
		Command command = targetEditPart.getCommand(request);

		return command;
	}

	/**
	 * Method getCreateCommand.
	 * 
	 * @param elementType
	 * @param sourceEditPart
	 * @param targetEditPart
	 * @return Command
	 */
	public static Command getCreateCommand(IElementType elementType,
			EditPart sourceEditPart, EditPart targetEditPart,
			PreferencesHint preferencesHint) {
		return getCreateCommand(new CreateConnectionViewAndElementRequest(
			elementType, preferencesHint), sourceEditPart, targetEditPart);
	}

	/**
	 * Propagates setting the parameters to the <code>CreateElementRequest</code> in my 
	 * {@link #getViewAndElementDescriptor()}.
	 */
	public void setExtendedData(Map map) {
		
		super.setExtendedData(map);
		
		ConnectionViewAndElementDescriptor descriptor = getConnectionViewAndElementDescriptor();
		
		if (descriptor != null) {
			CreateElementRequestAdapter adapter = descriptor
					.getCreateElementRequestAdapter();
			
			if (adapter != null) {
				CreateElementRequest request = (CreateElementRequest) adapter
						.getAdapter(CreateElementRequest.class);
		
				if (request != null) {
					request.getParameters().clear();
					request.addParameters(map);
				}
			}
		}
	}

}