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: 
f@0: package uk.ac.qmul.eecs.ccmi.network;
f@0: 
f@0: import uk.ac.qmul.eecs.ccmi.gui.DiagramEventSource;
f@0: import uk.ac.qmul.eecs.ccmi.utils.InteractionLog;
f@0: 
f@0: /**
f@0:  * A {@code Reply} message is sent from the server to a client from which it 
f@0:  * has just received a command. The reply acknowledges the client that the command has 
f@0:  * successfully been executed on the server. By broadcasting the command to the other client and by 
f@0:  * ending the reply to the client which issued the command itself the server keeps all the clients 
f@0:  * synchronized on its diagram model. 
f@0:  *
f@0:  */
f@0: public class Reply extends Message {
f@0: 	
f@0: 	public Reply(Name name, String diagram, String message, long timestamp, DiagramEventSource source){
f@0: 		super(timestamp,diagram, source);
f@0: 		this.name = name;
f@0: 		this.message = message;
f@0: 	}
f@0: 	
f@0: 	public Reply(Name name, String diagram, String message, DiagramEventSource source){
f@0: 		super(diagram,source);
f@0: 		this.name = name;
f@0: 		this.message = message;
f@0: 	}
f@0: 	
f@0: 	public Name getName() {
f@0: 		return name;
f@0: 	}
f@0: 	
f@0: 	public String getMessage() {
f@0: 		return message;
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public DiagramEventSource getSource(){
f@0: 		return (DiagramEventSource)super.getSource();
f@0: 	}
f@0: 	
f@0: 	/**
f@0: 	 * @return the length of the String message conveyed by this Reply 
f@0: 	 */
f@0: 	public int getMessageLen(){
f@0: 		return message.length();
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public String toString(){
f@0: 		StringBuilder builder = new StringBuilder();
f@0: 		builder.append(timestamp).append(' ').append(name).append('\n').append(message);
f@0: 		return builder.toString();
f@0: 	}
f@0: 
f@0: 	public static Name valueOf(String n){
f@0: 		Name name = Name.NONE_R;
f@0: 		try {
f@0: 			name = Name.valueOf(n);
f@0: 		}catch(IllegalArgumentException iae){
f@0: 			iae.printStackTrace();
f@0: 		}
f@0: 		return name;
f@0: 	}
f@0: 	
f@0: 	public static void log(Reply reply){
f@0: 		if(reply.getName() != Reply.Name.TRANSLATE_EDGE_R && reply.getName() != Reply.Name.TRANSLATE_NODE_R && reply.getName() != Reply.Name.BEND_R){
f@0: 			StringBuilder builder = new StringBuilder(reply.getName().toString());
f@0: 			builder.append(' ').append(reply.getDiagram());
f@0: 			builder.append(' ').append(reply.getMessage());
f@0: 			InteractionLog.log("SERVER", "reply received", builder.toString());
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	private Name name;
f@0: 	private String message;
f@0: 	private long timestamp;
f@0: 	public static final String NAME_POSTFIX = "_R";
f@0: 	public static enum Name implements Message.MessageName {
f@0: 		NONE_R,
f@0: 		OK_R,
f@0: 		ERROR_R,
f@0: 		LIST_R,
f@0: 		GET_R,
f@0: 		INSERT_NODE_R,
f@0: 		REMOVE_NODE_R,
f@0: 		INSERT_EDGE_R,
f@0: 		REMOVE_EDGE_R,
f@0: 		SET_NODE_NAME_R,
f@0: 		SET_EDGE_NAME_R,
f@0: 		SET_PROPERTY_R,
f@0: 		SET_PROPERTIES_R,
f@0: 		CLEAR_PROPERTIES_R,
f@0: 		SET_NOTES_R,
f@0: 		ADD_PROPERTY_R,
f@0: 		REMOVE_PROPERTY_R,
f@0: 		SET_MODIFIERS_R,
f@0: 		SET_ENDDESCRIPTION_R,
f@0: 		SET_ENDLABEL_R,
f@0: 		TRANSLATE_NODE_R,
f@0: 		TRANSLATE_EDGE_R,
f@0: 		BEND_R,
f@0: 		STOP_EDGE_MOVE_R,
f@0: 		STOP_NODE_MOVE_R;
f@0: 	};
f@0: }