/*
    WSMO Studio - a Semantic Web Service Editor
    Copyright (c) 2004-2007, Ontotext Lab. / SIRMA Group
    
    This library is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License as published by the Free
    Software Foundation; either version 2.1 of the License, or (at your option)
    any later version.
    This library is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
   details.
   You should have received a copy of the GNU Lesser General Public License along
   with this library; if not, write to the Free Software Foundation, Inc.,
   59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   */
  
  /***
   * <p>Title: WSMO Studio</p>
   * <p>Description: Semantic Web Service Editor</p>
   * <p>Copyright:  Copyright (c) 2004-2007</p>
   * <p>Company: Ontotext Lab. / SIRMA </p>
   */
  
  package org.wsmostudio.bpmo.ui.actions;
  
  import java.util.*;
  
  import org.eclipse.gef.EditPart;
  import org.eclipse.gef.ui.actions.SelectionAction;
  import org.eclipse.ui.IWorkbenchPart;
  import org.sbpm.bpmo.*;
  import org.wsmostudio.bpmo.model.WorkflowEntitiesContainer;
  import org.wsmostudio.bpmo.model.WorkflowEntityNode;
  import org.wsmostudio.bpmo.model.connectors.*;
  import org.wsmostudio.bpmo.model.io.BPMOImporter;
  import org.wsmostudio.bpmo.ui.editor.BpmoEditor;
  import org.wsmostudio.bpmo.ui.editor.layout.BPMOModelLayouter;
  import org.wsmostudio.runtime.LogManager;
  
  public abstract class AbstractDiagramAction extends SelectionAction {
  
      public AbstractDiagramAction(IWorkbenchPart part) {
          super(part);
      }
      
      /***
       * Runtime check if the selected object can be processed by this action. In case of
       * success this action appears in the context menu.
       * @param selected
       * @return
       */
      public abstract boolean isApplicableTo(Object selected);
      
      /***
       * Transform the selection from UI model to BPMO model
       * @return A BPMO process fragment or <code>null</code> if there is no current selection.
       */
      protected Set<WorkflowEntityNode> getDiagramSelection() {
  		List<?> sel = getSelectedObjects();
  		Set<WorkflowEntityNode> uiModels = new HashSet<WorkflowEntityNode>();
  		for(Object uiPart : sel) {
  			uiModels.add((WorkflowEntityNode)((EditPart)uiPart).getModel());
  		}
  		Set<WorkflowEntityNode> rootUIModels = new HashSet<WorkflowEntityNode>(uiModels);
  		for(Iterator<WorkflowEntityNode> iter = rootUIModels.iterator(); iter.hasNext();) {
  			if (uiModels.contains(iter.next().getOwner())) {
  				iter.remove();
  			}
  		}
  		return rootUIModels;
      }
      
      /***
       * Incorporates the result of the execution of this action in the diagram. 
       * Depending on the result of <code>isReplacingSelection()</code> the result either replaces
       * the initial selection or not.
       * @param fragment The result of the execution
       * @return <code>True</code> if the result is incorporated successfully
       */
      protected boolean replaceDiagramSelection(ProcessFragment fragment) {
  
      	Set<WorkflowEntityNode> uiNodes = 
      		new BPMOImporter().importProcessFragment(fragment);
      	
      	WorkflowEntitiesContainer owner = null;
      	Set<GraphConnector> inConns = new HashSet<GraphConnector>();
      	Set<GraphConnector> outConns = new HashSet<GraphConnector>();
      	Set<WorkflowEntityNode> oldSelection = new HashSet<WorkflowEntityNode>();
      	for (Object uiPart : getSelectedObjects()) {
      		if (false == uiPart instanceof EditPart 
      				|| false == ((EditPart)uiPart).getModel() instanceof WorkflowEntityNode) {
      		    continue;
      		}
      		WorkflowEntityNode oldUINode = (WorkflowEntityNode)((EditPart)uiPart).getModel();
      		oldSelection.add(oldUINode);
      		inConns.addAll(oldUINode.listInArcs());
      		outConns.addAll(oldUINode.listOutArcs());
      		if (owner == null) {
     		    owner = ((WorkflowEntityNode)((EditPart)uiPart).getModel()).getOwner();
     		}
     	}
     	if (owner == null) {
     		LogManager.logError("Unable to find the container of selection " + getSelectedObjects());
     		return false;
     	}
     	for(Iterator<GraphConnector> iter = inConns.iterator(); iter.hasNext(); ) {
     		if (oldSelection.contains(iter.next().getSource())) { // internal connection for the selection
     			iter.remove();
     		}
     	}
     	for(Iterator<GraphConnector> iter = outConns.iterator(); iter.hasNext(); ) {
     		if (oldSelection.contains(iter.next().getTarget())) { // internal connection for the selection
     			iter.remove();
     		}
     	}
     	
     	List<WorkflowEntityNode> startNodes = new LinkedList<WorkflowEntityNode>();
     	List<WorkflowEntityNode> endNodes = new LinkedList<WorkflowEntityNode>();
     	for (WorkflowEntityNode guiNode : uiNodes) {
     		if (guiNode.getOwner() == null) {
     			owner.addWorkflow(guiNode);
     		}
     		if (guiNode.listInArcs().size() == 0) {
     			startNodes.add(guiNode);
     		}
     		if (guiNode.listOutArcs().size() == 0) {
     			endNodes.add(guiNode);
     		}
     	}
     	
     	//Replace the existing incoming connectors with new ones referring the new result
     	for(GraphConnector conn : inConns) {
     		if (conn instanceof ControlflowArc) {
     		    for (WorkflowEntityNode newTarget : startNodes) {
     		    	new ControlflowArc(conn.getSource(), null, newTarget, null);
     		    }
     		}
     		conn.getSource().removeOutConnection(conn);
     		conn.getTarget().removeInConnection(conn);
     	}
     	
     	//Replace the existing outgoing connectors with new ones starting from the ends of the new result
     	for(GraphConnector conn : outConns) {
     		if (conn instanceof ControlflowArc) {
     		    for (WorkflowEntityNode newSource : endNodes) {
     		    	new ControlflowArc(newSource, null, conn.getTarget(), null);
     		    }
     		}
     		conn.getSource().removeOutConnection(conn);
     		conn.getTarget().removeInConnection(conn);
     	}
     	
     	// remove the old selection
     	for(WorkflowEntityNode oldNode : oldSelection) {
     		oldNode.getOwner().removeWorkflow(oldNode);
     	}
         BPMOModelLayouter.doLayout(((BpmoEditor)getWorkbenchPart()).getModel());
         ((BpmoEditor)getWorkbenchPart()).updateView();
         ((BpmoEditor)getWorkbenchPart()).markDirty();
         
         return true;
     }
     
     // the extenders MUST define any behavior
     public abstract void run();
 
 }