fiore@0: /*  
fiore@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
fiore@0:   
fiore@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
fiore@0: 
fiore@0:  This program is free software: you can redistribute it and/or modify
fiore@0:  it under the terms of the GNU General Public License as published by
fiore@0:  the Free Software Foundation, either version 3 of the License, or
fiore@0:  (at your option) any later version.
fiore@0: 
fiore@0:  This program is distributed in the hope that it will be useful,
fiore@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
fiore@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fiore@0:  GNU General Public License for more details.
fiore@0: 
fiore@0:  You should have received a copy of the GNU General Public License
fiore@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
fiore@0: */
fiore@0: package uk.ac.qmul.eecs.ccmi.gui;
fiore@0: 
fiore@0: import java.awt.geom.Point2D;
fiore@0: import java.util.Set;
fiore@0: 
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.CollectionModel;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramElement;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramModel;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramModelTreeNode;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.NodeProperties;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.TreeModel;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.persistence.PrototypePersistenceDelegate;
fiore@0: 
fiore@0: /**
fiore@0:  * This Diagram class holds all the data needed for a representation of the diagram. It is used by component classes 
fiore@0:  * such as {@link GraphPanel} and {@link DiagramTree} to draw the diagram by accessing the diagram model or by 
fiore@0:  * {@link EditorTabbedPane} to assign a title to the tabs out of the diagram name. 
fiore@0:  * 
fiore@0:  *
fiore@0:  */
fiore@0: public abstract class Diagram implements Cloneable {
fiore@0: 	
fiore@0: 	public static Diagram newInstance(String name, Node[] nodes, Edge[] edges, PrototypePersistenceDelegate prototypePersistenceDelegate){
fiore@0: 		return new LocalDiagram(name,nodes,edges,prototypePersistenceDelegate);
fiore@0: 	}
fiore@0: 	
fiore@0: 	public abstract String getName();
fiore@0: 
fiore@0: 	public abstract void setName(String name);
fiore@0: 
fiore@0: 	public abstract Node[] getNodePrototypes();
fiore@0: 
fiore@0: 	public abstract Edge[] getEdgePrototypes();
fiore@0: 
fiore@0: 	public abstract TreeModel<Node,Edge> getTreeModel();
fiore@0: 
fiore@0: 	public abstract CollectionModel<Node,Edge> getCollectionModel();
fiore@0: 
fiore@0: 	public abstract DiagramModelUpdater getModelUpdater();
fiore@0: 	
fiore@0: 	public abstract String getLabel();
fiore@0: 	
fiore@0: 	public abstract PrototypePersistenceDelegate getPrototypePersistenceDelegate();
fiore@0: 
fiore@0: 	@Override
fiore@0: 	public Object clone(){
fiore@0: 		try {
fiore@0: 			return super.clone();
fiore@0: 		} catch (CloneNotSupportedException e) {
fiore@0: 			throw new RuntimeException(e);
fiore@0: 		}
fiore@0: 	}
fiore@0: 	
fiore@0: 	private static class LocalDiagram extends Diagram {
fiore@0: 
fiore@0: 		private LocalDiagram(String name, Node[] nodes, Edge[] edges,PrototypePersistenceDelegate prototypePersistenceDelegate){
fiore@0: 			this.name = name;
fiore@0: 			this.nodes = nodes;
fiore@0: 			this.edges = edges;
fiore@0: 			this.prototypePersistenceDelegate = prototypePersistenceDelegate;
fiore@0: 			diagramModel = new DiagramModel<Node,Edge>(nodes,edges);
fiore@0: 			innerModelUpdater = new InnerModelUpdater();
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public String getName(){
fiore@0: 			return name;
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public void setName(String name){
fiore@0: 			this.name = name;
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public Node[] getNodePrototypes(){
fiore@0: 			return nodes;
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public Edge[] getEdgePrototypes(){
fiore@0: 			return edges;
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public TreeModel<Node,Edge> getTreeModel(){
fiore@0: 			return diagramModel.getTreeModel();
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public CollectionModel<Node,Edge> getCollectionModel(){
fiore@0: 			return diagramModel.getDiagramCollection();
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public String getLabel(){
fiore@0: 			return name;
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public DiagramModelUpdater getModelUpdater(){
fiore@0: 			return innerModelUpdater;
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public String toString(){
fiore@0: 			return name;
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public PrototypePersistenceDelegate getPrototypePersistenceDelegate(){
fiore@0: 			return prototypePersistenceDelegate;
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public Object clone(){
fiore@0: 			LocalDiagram clone = (LocalDiagram)super.clone();
fiore@0: 			clone.name = getName();
fiore@0: 			clone.nodes = getNodePrototypes();
fiore@0: 			clone.edges = getEdgePrototypes();
fiore@0: 			/* constructor with no args makes just a dummy wrapper */
fiore@0: 			clone.diagramModel = new DiagramModel<Node,Edge>(nodes,edges);
fiore@0: 			clone.innerModelUpdater = clone.new InnerModelUpdater();
fiore@0: 			return clone;
fiore@0: 		}
fiore@0: 
fiore@0: 		private DiagramModel<Node,Edge> diagramModel;
fiore@0: 		private InnerModelUpdater innerModelUpdater;
fiore@0: 		private PrototypePersistenceDelegate prototypePersistenceDelegate;
fiore@0: 		private String name;
fiore@0: 		private Node[] nodes;
fiore@0: 		private Edge[] edges;
fiore@0: 
fiore@0: 		private class InnerModelUpdater implements DiagramModelUpdater {
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public boolean getLock(DiagramModelTreeNode treeNode, Lock lock) {
fiore@0: 				/* using a non shared diagram requires no actual lock, therefore the answer is always yes */
fiore@0: 				return true;
fiore@0: 			}
fiore@0: 			
fiore@0: 			@Override
fiore@0: 			public void yieldLock(DiagramModelTreeNode treeNode, Lock lock) {}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void insertInCollection(DiagramElement element) {
fiore@0: 				if(element instanceof Node)
fiore@0: 					diagramModel.getDiagramCollection().insert((Node)element);
fiore@0: 				else
fiore@0: 					diagramModel.getDiagramCollection().insert((Edge)element);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void insertInTree(DiagramElement element) {
fiore@0: 				if(element instanceof Node)
fiore@0: 					diagramModel.getTreeModel().insertTreeNode((Node)element);
fiore@0: 				else
fiore@0: 					diagramModel.getTreeModel().insertTreeNode((Edge)element);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void takeOutFromCollection(DiagramElement element) {
fiore@0: 				diagramModel.getDiagramCollection().takeOut(element);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void takeOutFromTree(DiagramElement element) {
fiore@0: 				diagramModel.getDiagramCollection().takeOut(element);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setName(DiagramElement element, String name) {
fiore@0: 				element.setName(name);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setNotes(DiagramModelTreeNode treeNode, String notes) {
fiore@0: 				diagramModel.getTreeModel().setNotes(treeNode, notes);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setProperty(Node node, String type, int index,
fiore@0: 					String value) {
fiore@0: 				node.setProperty(type, index, value);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setProperties(Node node, NodeProperties properties) {
fiore@0: 				node.setProperties(properties);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void clearProperties(Node node) {
fiore@0: 				node.clearProperties();
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void addProperty(Node node, String type, String value) {
fiore@0: 				node.addProperty(type, value);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void removeProperty(Node node, String type, int index) {
fiore@0: 				node.removeProperty(type, index);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setModifiers(Node node, String type, int index,
fiore@0: 					Set<Integer> modifiers) {
fiore@0: 				node.setModifierIndexes(type, index, modifiers);				
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setEndLabel(Edge edge, Node node, String label) {
fiore@0: 				edge.setEndLabel(node, label);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void setEndDescription(Edge edge, Node node,
fiore@0: 					int index) {
fiore@0: 				edge.setEndDescription(node, index);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void translate(GraphElement ge, Point2D p, double x, double y) {
fiore@0: 				ge.translate(p, x, y);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void startMove(GraphElement ge, Point2D p) {
fiore@0: 				ge.startMove(p);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void bend(Edge edge, Point2D p) {
fiore@0: 				edge.bend(p);
fiore@0: 			}
fiore@0: 
fiore@0: 			@Override
fiore@0: 			public void stopMove(GraphElement ge) {
fiore@0: 				ge.stopMove();
fiore@0: 			}
fiore@0: 		}
fiore@0: 	}
fiore@0: 
fiore@0: }