plugins/org.eclipse.amalgam.explorer.activity.ui/src/org/eclipse/amalgam/explorer/activity/ui/api/hyperlinkadapter/AbstractNewDiagramHyperlinkAdapter.java

/*******************************************************************************
 * Copyright (c)  2006, 2015 THALES GLOBAL SERVICES.
 * 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:
 *    Thales - initial API and implementation
 *******************************************************************************/
package org.eclipse.amalgam.explorer.activity.ui.api.hyperlinkadapter;

import java.util.Collection;

import org.eclipse.amalgam.explorer.activity.ui.internal.viewer.diagram.actions.NewRepresentationAction;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.transaction.RecordingCommand;
import org.eclipse.emf.transaction.util.TransactionUtil;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.sirius.business.api.dialect.DialectManager;
import org.eclipse.sirius.business.api.session.Session;
import org.eclipse.sirius.viewpoint.description.RepresentationDescription;
import org.eclipse.sirius.viewpoint.description.Viewpoint;
import org.eclipse.ui.forms.events.HyperlinkEvent;
import org.eclipse.ui.forms.widgets.AbstractHyperlink;

/**
 * Base class to implement a diagram creation.
 * 
 */
public abstract class AbstractNewDiagramHyperlinkAdapter extends AbstractHyperlinkAdapter {

	// private Logger _logger =
	// ReportManagerRegistry.getInstance().subscribe(IReportManagerDefaultComponents.DIAGRAM);

	/**
	 * Constructor.
	 * 
	 * @param project_p
	 * @param session_p
	 */
	public AbstractNewDiagramHyperlinkAdapter(EObject project_p, Session session_p) {
		super(project_p, session_p);
	}

	/**
	 * Create a diagram based on {@link #getDiagramRepresentation()},
	 * {@link #getModelElement(Project))} and the current session.<br>
	 * Must be in the UI thread.
	 */
	protected boolean createDiagram(final EObject project_p, final Session session_p) {
		final boolean flag[] = { true };
		RecordingCommand cmd = new RecordingCommand(TransactionUtil.getEditingDomain(project_p)) {

			@Override
			protected void doExecute() {
				//
				EObject modelElement = project_p;
				// Precondition
				if (null == modelElement) {
					flag[0] = false;
				} else {
					RepresentationDescription diagramRepresentation = getDiagramRepresentation(session_p, modelElement);
					// Preconditions
					if ((null == diagramRepresentation)
							|| !DialectManager.INSTANCE.canCreate(modelElement, diagramRepresentation)) {
						flag[0] = false;
					} else {
						NewRepresentationAction newDiagramAction = new NewRepresentationAction(diagramRepresentation,
								modelElement, session_p);
						newDiagramAction.run();
					}
				}

			}
		};
		TransactionUtil.getEditingDomain(project_p).getCommandStack().execute(cmd);

		return flag[0];
	}

	@Override
	protected void linkPressed(HyperlinkEvent event_p, EObject root_p, Session session_p) {
		if (!createDiagram(root_p, session_p)) {
			handleDiagramCreationError(event_p, root_p);
		}
	}

	/**
	 * Handle creation error.
	 * 
	 * @param event_p
	 * @param project_p
	 */
	protected void handleDiagramCreationError(HyperlinkEvent event_p, EObject project_p) {
		String msg = Messages.AbstractNewDiagramHyperlinkAdapter_DiagramCreation_Error_Msg_Part1
				+ getRepresentationName() + Messages.AbstractNewDiagramHyperlinkAdapter_DiagramCreation_Error_Msg_Part2;
		AbstractHyperlink widget = (AbstractHyperlink) event_p.widget;
		MessageDialog.openError(widget.getDisplay().getActiveShell(), widget.getText(), msg);
		// _logger.error(new EmbeddedMessage(msg,
		// IReportManagerDefaultComponents.DIAGRAM, project_p));
	}

	/**
	 * Get the diagram representation for {@link #getRepresentationName()} and
	 * specified parameters.
	 * 
	 * @return <code>null</code> if not found.
	 */

	protected RepresentationDescription getDiagramRepresentation(Session session_p, EObject modelElement) {
		// Get active viewpoints.
		Collection<Viewpoint> activeViewpoints = session_p.getSelectedViewpoints(false);
		Collection<RepresentationDescription> diagramDescriptions = DialectManager.INSTANCE
				.getAvailableRepresentationDescriptions(activeViewpoints, modelElement);
		// Get search diagram name.
		String diagramName = getRepresentationName();
		// Loop over retrieved diagram descriptions to search one matching
		// search diagram name.
		for (RepresentationDescription diagramDescription : diagramDescriptions) {
			if (diagramName.equals(diagramDescription.getName())) {
				return diagramDescription;
			}
		}
		return null;
	}

	/**
	 * @return
	 */
	public abstract String getRepresentationName();
}