f@0: /*  
f@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0:   
f@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0: 
f@0:  This program is free software: you can redistribute it and/or modify
f@0:  it under the terms of the GNU General Public License as published by
f@0:  the Free Software Foundation, either version 3 of the License, or
f@0:  (at your option) any later version.
f@0: 
f@0:  This program is distributed in the hope that it will be useful,
f@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f@0:  GNU General Public License for more details.
f@0: 
f@0:  You should have received a copy of the GNU General Public License
f@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
f@0: */
f@0: package uk.ac.qmul.eecs.ccmi.diagrammodel;
f@0: 
f@0: /**
f@0:  * The diagramModeltreeNode placed in a node subtree representing an edge connecting 
f@0:  * that node with another node.
f@0:  */
f@0: @SuppressWarnings("serial")
f@0: public class EdgeReferenceMutableTreeNode extends DiagramTreeNode {
f@0: 	EdgeReferenceMutableTreeNode(DiagramEdge edge, DiagramNode node){
f@0: 		super();
f@0: 		this.edge = edge;
f@0: 		this.node = node;
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public String toString(){
f@0: 		final String and = " and ";
f@0: 		StringBuilder b = new StringBuilder();
f@0: 		b.append("to ");
f@0: 		for(int i=0;i<edge.getNodesNum();i++){
f@0: 			DiagramNode n = edge.getNodeAt(i);
f@0: 			if(!n.equals(node))
f@0: 				b.append(n.getName()).append(and);
f@0: 		}
f@0: 		// remove the last " and "
f@0: 		b.delete(b.length()-and.length(), b.length());
f@0: 		b.append(", via ");
f@0: 		b.append(edge.getName());
f@0: 		super.setUserObject(b.toString());
f@0: 		return super.toString();
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public String getName(){
f@0: 		return toString();
f@0: 	}
f@0: 	
f@0: 	/**
f@0: 	 * Return a String representing this object for this tree node in a way more suitable 
f@0: 	 * for a text to speech synthesizer to read, than toString(). 
f@0: 	 * @return a String suitable for text to speech synthesis
f@0: 	 */
f@0: 	@Override
f@0: 	public String spokenText(){
f@0: 		toString();
f@0: 		return super.spokenText();
f@0: 	}
f@0: 	
f@0: 	/**
f@0: 	 * Returns the diagram edge that this tree node represents inside the node subtree 
f@0: 	 * @return a reference to the actual edge
f@0: 	 */
f@0: 	public DiagramEdge getEdge(){
f@0: 		return edge;
f@0: 	}
f@0: 	
f@0: 	/**
f@0: 	 * Returns the node containing this tree node in its subtree. Notice that 
f@0: 	 * diagram nodes are DiagrammodelTreeNode as well. 
f@0: 	 * @return a reference to the diagram node
f@0: 	 */
f@0: 	public DiagramNode getNode(){
f@0: 		return node;
f@0: 	}
f@0: 	
f@0: 	private DiagramEdge edge;
f@0: 	private DiagramNode node;
f@0: }