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.diagrammodel;
fiore@0: 
fiore@0: /**
fiore@0:  * The diagramModeltreeNode placed in a node subtree representing an edge connecting 
fiore@0:  * that node with another node.
fiore@0:  */
fiore@0: @SuppressWarnings("serial")
fiore@3: public class EdgeReferenceMutableTreeNode extends DiagramTreeNode {
fiore@3: 	EdgeReferenceMutableTreeNode(DiagramEdge edge, DiagramNode node){
fiore@0: 		super();
fiore@0: 		this.edge = edge;
fiore@0: 		this.node = node;
fiore@0: 	}
fiore@0: 	
fiore@0: 	@Override
fiore@0: 	public String toString(){
fiore@0: 		final String and = " and ";
fiore@0: 		StringBuilder b = new StringBuilder();
fiore@0: 		b.append("to ");
fiore@0: 		for(int i=0;i<edge.getNodesNum();i++){
fiore@0: 			DiagramNode n = edge.getNodeAt(i);
fiore@0: 			if(!n.equals(node))
fiore@0: 				b.append(n.getName()).append(and);
fiore@0: 		}
fiore@0: 		// remove the last " and "
fiore@0: 		b.delete(b.length()-and.length(), b.length());
fiore@0: 		b.append(", via ");
fiore@0: 		b.append(edge.getName());
fiore@0: 		super.setUserObject(b.toString());
fiore@0: 		return super.toString();
fiore@0: 	}
fiore@0: 	
fiore@0: 	@Override
fiore@0: 	public String getName(){
fiore@0: 		return toString();
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@0: 	 * Return a String representing this object for this tree node in a way more suitable 
fiore@0: 	 * for a text to speech synthesizer to read, than toString(). 
fiore@0: 	 * @return a String suitable for text to speech synthesis
fiore@0: 	 */
fiore@0: 	@Override
fiore@0: 	public String spokenText(){
fiore@0: 		toString();
fiore@0: 		return super.spokenText();
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@0: 	 * Returns the diagram edge that this tree node represents inside the node subtree 
fiore@0: 	 * @return a reference to the actual edge
fiore@0: 	 */
fiore@0: 	public DiagramEdge getEdge(){
fiore@0: 		return edge;
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@0: 	 * Returns the node containing this tree node in its subtree. Notice that 
fiore@0: 	 * diagram nodes are DiagrammodelTreeNode as well. 
fiore@0: 	 * @return a reference to the diagram node
fiore@0: 	 */
fiore@0: 	public DiagramNode getNode(){
fiore@0: 		return node;
fiore@0: 	}
fiore@0: 	
fiore@0: 	private DiagramEdge edge;
fiore@0: 	private DiagramNode node;
fiore@0: }