/*
* 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.modelepedia.istar.diagram.edit.policies;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.gef.EditPart;
import org.eclipse.gef.commands.Command;
import org.eclipse.gmf.runtime.diagram.core.util.ViewUtil;
import org.eclipse.gmf.runtime.diagram.ui.commands.DeferredLayoutCommand;
import org.eclipse.gmf.runtime.diagram.ui.commands.ICommandProxy;
import org.eclipse.gmf.runtime.diagram.ui.commands.SetViewMutabilityCommand;
import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
import org.eclipse.gmf.runtime.diagram.ui.editpolicies.CanonicalEditPolicy;
import org.eclipse.gmf.runtime.diagram.ui.requests.CreateConnectionViewRequest;
import org.eclipse.gmf.runtime.diagram.ui.requests.CreateViewRequest;
import org.eclipse.gmf.runtime.diagram.ui.requests.RequestConstants;
import org.eclipse.gmf.runtime.emf.core.util.EObjectAdapter;
import org.eclipse.gmf.runtime.notation.Diagram;
import org.eclipse.gmf.runtime.notation.Edge;
import org.eclipse.gmf.runtime.notation.Node;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.gmf.tooling.runtime.update.UpdaterLinkDescriptor;
import edu.toronto.cs.se.modelepedia.istar.IStarPackage;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.ActorEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.ContributionEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.DecompositionEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.DependeeLinkEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.DependerLinkEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.Goal2EditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.GoalEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.IStarEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.MeansEndEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.Resource2EditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.ResourceEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.SoftGoal2EditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.SoftGoalEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.Task2EditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.edit.parts.TaskEditPart;
import edu.toronto.cs.se.modelepedia.istar.diagram.part.IStarDiagramUpdater;
import edu.toronto.cs.se.modelepedia.istar.diagram.part.IStarLinkDescriptor;
import edu.toronto.cs.se.modelepedia.istar.diagram.part.IStarNodeDescriptor;
import edu.toronto.cs.se.modelepedia.istar.diagram.part.IStarVisualIDRegistry;
/**
* @generated
*/
public class IStarCanonicalEditPolicy extends CanonicalEditPolicy {
/**
* @generated
*/
private Set<EStructuralFeature> myFeaturesToSynchronize;
/**
* @generated
*/
protected void refreshOnActivate() {
// Need to activate editpart children before invoking the canonical refresh for EditParts to add event listeners
List<?> c = getHost().getChildren();
for (int i = 0; i < c.size(); i++) {
((EditPart) c.get(i)).activate();
}
super.refreshOnActivate();
}
/**
* @generated
*/
protected Set getFeaturesToSynchronize() {
if (myFeaturesToSynchronize == null) {
myFeaturesToSynchronize = new HashSet<EStructuralFeature>();
myFeaturesToSynchronize.add(IStarPackage.eINSTANCE
.getIStar_Dependums());
myFeaturesToSynchronize.add(IStarPackage.eINSTANCE
.getIStar_Actors());
}
return myFeaturesToSynchronize;
}
/**
* @generated
*/
@SuppressWarnings("rawtypes")
protected List getSemanticChildrenList() {
View viewObject = (View) getHost().getModel();
LinkedList<EObject> result = new LinkedList<EObject>();
List<IStarNodeDescriptor> childDescriptors = IStarDiagramUpdater
.getIStar_1000SemanticChildren(viewObject);
for (IStarNodeDescriptor d : childDescriptors) {
result.add(d.getModelElement());
}
return result;
}
/**
* @generated
*/
protected boolean isOrphaned(Collection<EObject> semanticChildren,
final View view) {
if (isShortcut(view)) {
return IStarDiagramUpdater.isShortcutOrphaned(view);
}
return isMyDiagramElement(view)
&& !semanticChildren.contains(view.getElement());
}
/**
* @generated
*/
private boolean isMyDiagramElement(View view) {
int visualID = IStarVisualIDRegistry.getVisualID(view);
switch (visualID) {
case SoftGoalEditPart.VISUAL_ID:
case TaskEditPart.VISUAL_ID:
case ResourceEditPart.VISUAL_ID:
case GoalEditPart.VISUAL_ID:
case ActorEditPart.VISUAL_ID:
return true;
}
return false;
}
/**
* @generated
*/
protected static boolean isShortcut(View view) {
return view.getEAnnotation("Shortcut") != null; //$NON-NLS-1$
}
/**
* @generated
*/
protected void refreshSemantic() {
if (resolveSemanticElement() == null) {
return;
}
LinkedList<IAdaptable> createdViews = new LinkedList<IAdaptable>();
List<IStarNodeDescriptor> childDescriptors = IStarDiagramUpdater
.getIStar_1000SemanticChildren((View) getHost().getModel());
LinkedList<View> orphaned = new LinkedList<View>();
// we care to check only views we recognize as ours and not shortcuts
LinkedList<View> knownViewChildren = new LinkedList<View>();
for (View v : getViewChildren()) {
if (isShortcut(v)) {
if (IStarDiagramUpdater.isShortcutOrphaned(v)) {
orphaned.add(v);
}
continue;
}
if (isMyDiagramElement(v)) {
knownViewChildren.add(v);
}
}
// alternative to #cleanCanonicalSemanticChildren(getViewChildren(), semanticChildren)
//
// iteration happens over list of desired semantic elements, trying to find best matching View, while original CEP
// iterates views, potentially losing view (size/bounds) information - i.e. if there are few views to reference same EObject, only last one
// to answer isOrphaned == true will be used for the domain element representation, see #cleanCanonicalSemanticChildren()
for (Iterator<IStarNodeDescriptor> descriptorsIterator = childDescriptors
.iterator(); descriptorsIterator.hasNext();) {
IStarNodeDescriptor next = descriptorsIterator.next();
String hint = IStarVisualIDRegistry.getType(next.getVisualID());
LinkedList<View> perfectMatch = new LinkedList<View>(); // both semanticElement and hint match that of NodeDescriptor
for (View childView : getViewChildren()) {
EObject semanticElement = childView.getElement();
if (next.getModelElement().equals(semanticElement)) {
if (hint.equals(childView.getType())) {
perfectMatch.add(childView);
// actually, can stop iteration over view children here, but
// may want to use not the first view but last one as a 'real' match (the way original CEP does
// with its trick with viewToSemanticMap inside #cleanCanonicalSemanticChildren
}
}
}
if (perfectMatch.size() > 0) {
descriptorsIterator.remove(); // precise match found no need to create anything for the NodeDescriptor
// use only one view (first or last?), keep rest as orphaned for further consideration
knownViewChildren.remove(perfectMatch.getFirst());
}
}
// those left in knownViewChildren are subject to removal - they are our diagram elements we didn't find match to,
// or those we have potential matches to, and thus need to be recreated, preserving size/location information.
orphaned.addAll(knownViewChildren);
//
ArrayList<CreateViewRequest.ViewDescriptor> viewDescriptors = new ArrayList<CreateViewRequest.ViewDescriptor>(
childDescriptors.size());
for (IStarNodeDescriptor next : childDescriptors) {
String hint = IStarVisualIDRegistry.getType(next.getVisualID());
IAdaptable elementAdapter = new CanonicalElementAdapter(
next.getModelElement(), hint);
CreateViewRequest.ViewDescriptor descriptor = new CreateViewRequest.ViewDescriptor(
elementAdapter, Node.class, hint, ViewUtil.APPEND, false,
host().getDiagramPreferencesHint());
viewDescriptors.add(descriptor);
}
boolean changed = deleteViews(orphaned.iterator());
//
CreateViewRequest request = getCreateViewRequest(viewDescriptors);
Command cmd = getCreateViewCommand(request);
if (cmd != null && cmd.canExecute()) {
SetViewMutabilityCommand.makeMutable(
new EObjectAdapter(host().getNotationView())).execute();
executeCommand(cmd);
@SuppressWarnings("unchecked")
List<IAdaptable> nl = (List<IAdaptable>) request.getNewObject();
createdViews.addAll(nl);
}
if (changed || createdViews.size() > 0) {
postProcessRefreshSemantic(createdViews);
}
Collection<IAdaptable> createdConnectionViews = refreshConnections();
if (createdViews.size() > 1) {
// perform a layout of the container
DeferredLayoutCommand layoutCmd = new DeferredLayoutCommand(host()
.getEditingDomain(), createdViews, host());
executeCommand(new ICommandProxy(layoutCmd));
}
createdViews.addAll(createdConnectionViews);
makeViewsImmutable(createdViews);
}
/**
* @generated
*/
private Collection<IAdaptable> refreshConnections() {
Domain2Notation domain2NotationMap = new Domain2Notation();
Collection<IStarLinkDescriptor> linkDescriptors = collectAllLinks(
getDiagram(), domain2NotationMap);
Collection existingLinks = new LinkedList(getDiagram().getEdges());
for (Iterator linksIterator = existingLinks.iterator(); linksIterator
.hasNext();) {
Edge nextDiagramLink = (Edge) linksIterator.next();
int diagramLinkVisualID = IStarVisualIDRegistry
.getVisualID(nextDiagramLink);
if (diagramLinkVisualID == -1) {
if (nextDiagramLink.getSource() != null
&& nextDiagramLink.getTarget() != null) {
linksIterator.remove();
}
continue;
}
EObject diagramLinkObject = nextDiagramLink.getElement();
EObject diagramLinkSrc = nextDiagramLink.getSource().getElement();
EObject diagramLinkDst = nextDiagramLink.getTarget().getElement();
for (Iterator<IStarLinkDescriptor> linkDescriptorsIterator = linkDescriptors
.iterator(); linkDescriptorsIterator.hasNext();) {
IStarLinkDescriptor nextLinkDescriptor = linkDescriptorsIterator
.next();
if (diagramLinkObject == nextLinkDescriptor.getModelElement()
&& diagramLinkSrc == nextLinkDescriptor.getSource()
&& diagramLinkDst == nextLinkDescriptor
.getDestination()
&& diagramLinkVisualID == nextLinkDescriptor
.getVisualID()) {
linksIterator.remove();
linkDescriptorsIterator.remove();
break;
}
}
}
deleteViews(existingLinks.iterator());
return createConnections(linkDescriptors, domain2NotationMap);
}
/**
* @generated
*/
private Collection<IStarLinkDescriptor> collectAllLinks(View view,
Domain2Notation domain2NotationMap) {
if (!IStarEditPart.MODEL_ID.equals(IStarVisualIDRegistry
.getModelID(view))) {
return Collections.emptyList();
}
LinkedList<IStarLinkDescriptor> result = new LinkedList<IStarLinkDescriptor>();
switch (IStarVisualIDRegistry.getVisualID(view)) {
case IStarEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getIStar_1000ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case SoftGoalEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getSoftGoal_2001ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case TaskEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getTask_2002ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case ResourceEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getResource_2003ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case GoalEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getGoal_2004ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case ActorEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getActor_2005ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case SoftGoal2EditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getSoftGoal_3001ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case Task2EditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getTask_3002ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case Resource2EditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getResource_3003ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case Goal2EditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getGoal_3004ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case MeansEndEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getMeansEnd_4001ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case DecompositionEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getDecomposition_4002ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case ContributionEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getContribution_4003ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case DependerLinkEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getDependerLink_4004ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
case DependeeLinkEditPart.VISUAL_ID: {
if (!domain2NotationMap.containsKey(view.getElement())) {
result.addAll(IStarDiagramUpdater
.getDependeeLink_4005ContainedLinks(view));
}
domain2NotationMap.putView(view.getElement(), view);
break;
}
}
for (Iterator children = view.getChildren().iterator(); children
.hasNext();) {
result.addAll(collectAllLinks((View) children.next(),
domain2NotationMap));
}
for (Iterator edges = view.getSourceEdges().iterator(); edges.hasNext();) {
result.addAll(collectAllLinks((View) edges.next(),
domain2NotationMap));
}
return result;
}
/**
* @generated
*/
private Collection<IAdaptable> createConnections(
Collection<IStarLinkDescriptor> linkDescriptors,
Domain2Notation domain2NotationMap) {
LinkedList<IAdaptable> adapters = new LinkedList<IAdaptable>();
for (IStarLinkDescriptor nextLinkDescriptor : linkDescriptors) {
EditPart sourceEditPart = getSourceEditPart(nextLinkDescriptor,
domain2NotationMap);
EditPart targetEditPart = getTargetEditPart(nextLinkDescriptor,
domain2NotationMap);
if (sourceEditPart == null || targetEditPart == null) {
continue;
}
CreateConnectionViewRequest.ConnectionViewDescriptor descriptor = new CreateConnectionViewRequest.ConnectionViewDescriptor(
nextLinkDescriptor.getSemanticAdapter(),
IStarVisualIDRegistry.getType(nextLinkDescriptor
.getVisualID()), ViewUtil.APPEND, false,
((IGraphicalEditPart) getHost())
.getDiagramPreferencesHint());
CreateConnectionViewRequest ccr = new CreateConnectionViewRequest(
descriptor);
ccr.setType(RequestConstants.REQ_CONNECTION_START);
ccr.setSourceEditPart(sourceEditPart);
sourceEditPart.getCommand(ccr);
ccr.setTargetEditPart(targetEditPart);
ccr.setType(RequestConstants.REQ_CONNECTION_END);
Command cmd = targetEditPart.getCommand(ccr);
if (cmd != null && cmd.canExecute()) {
executeCommand(cmd);
IAdaptable viewAdapter = (IAdaptable) ccr.getNewObject();
if (viewAdapter != null) {
adapters.add(viewAdapter);
}
}
}
return adapters;
}
/**
* @generated
*/
private EditPart getEditPart(EObject domainModelElement,
Domain2Notation domain2NotationMap) {
View view = (View) domain2NotationMap.get(domainModelElement);
if (view != null) {
return (EditPart) getHost().getViewer().getEditPartRegistry()
.get(view);
}
return null;
}
/**
* @generated
*/
private Diagram getDiagram() {
return ((View) getHost().getModel()).getDiagram();
}
/**
* @generated
*/
private EditPart getSourceEditPart(UpdaterLinkDescriptor descriptor,
Domain2Notation domain2NotationMap) {
return getEditPart(descriptor.getSource(), domain2NotationMap);
}
/**
* @generated
*/
private EditPart getTargetEditPart(UpdaterLinkDescriptor descriptor,
Domain2Notation domain2NotationMap) {
return getEditPart(descriptor.getDestination(), domain2NotationMap);
}
/**
* @generated
*/
protected final EditPart getHintedEditPart(EObject domainModelElement,
Domain2Notation domain2NotationMap, int hintVisualId) {
View view = (View) domain2NotationMap.getHinted(domainModelElement,
IStarVisualIDRegistry.getType(hintVisualId));
if (view != null) {
return (EditPart) getHost().getViewer().getEditPartRegistry()
.get(view);
}
return null;
}
/**
* @generated
*/
@SuppressWarnings("serial")
protected static class Domain2Notation extends HashMap<EObject, View> {
/**
* @generated
*/
public boolean containsDomainElement(EObject domainElement) {
return this.containsKey(domainElement);
}
/**
* @generated
*/
public View getHinted(EObject domainEObject, String hint) {
return this.get(domainEObject);
}
/**
* @generated
*/
public void putView(EObject domainElement, View view) {
if (!containsKey(view.getElement()) || !isShortcut(view)) {
this.put(domainElement, view);
}
}
}
}