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.CharEscaper;
f@0: import uk.ac.qmul.eecs.ccmi.utils.InteractionLog;
f@0: 
f@0: /**
f@0:  * A command message that triggers an update in the model of the target diagram. Possible updates
f@0:  * are those listed in the {@code MessageName} enum.  
f@0:  * Command messages are issued by both clients and server. Clients commands are sent after a
f@0:  * user action. When the server receives a command it broadcasts it to all the clients but the one
f@0:  * from which the command was from. 
f@0:  *
f@0:  */
f@0: public class Command extends Message {
f@0: 	public Command(Name name, String diagram, Object[] args, long timestamp, DiagramEventSource source){
f@0: 		super(timestamp,diagram,source);
f@0: 		this.name = name;
f@0: 		this.args = args;
f@0: 	}
f@0: 	
f@0: 	public Command(Name name, String diagram, Object[] args, DiagramEventSource source){
f@0: 		super(diagram,source);
f@0: 		this.name = name;
f@0: 		this.args = args;
f@0: 	}
f@0: 	
f@0: 	public Command(Name name, String diagram, long timestamp, DiagramEventSource source){
f@0: 		this(name, diagram, source);
f@0: 	}
f@0: 	
f@0: 	public Command(Name name, String diagram, DiagramEventSource source){
f@0: 		this(name, diagram, new Object[]{},source);
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public DiagramEventSource getSource(){
f@0: 		return (DiagramEventSource)super.getSource();
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public Name getName() {
f@0: 		return name;
f@0: 	}
f@0: 
f@0: 	public Object getArgAt(int index) {
f@0: 		return args[index];
f@0: 	}
f@0: 	
f@0: 	public Object[] getArgs(){
f@0: 		return args;
f@0: 	}
f@0: 
f@0: 	public int getArgNum(){
f@0: 		return args.length;
f@0: 	}
f@0: 	
f@0: 
f@0: 	/**
f@0: 	 * Utility method to log, through the interaction log, the receipt of a command 
f@0: 	 * @param cmd the received command 
f@0: 	 * @param action a further description of the action that triggered this command 
f@0: 	 */
f@0: 	public static void log(Command cmd, String action){
f@0: 		if(cmd.getName() != Command.Name.LOCAL && cmd.getName() != Command.Name.BEND 
f@0: 				&& cmd.getName() != Command.Name.TRANSLATE_EDGE && cmd.getName() != Command.Name.TRANSLATE_NODE){
f@0: 			StringBuilder builder = new StringBuilder(cmd.getName().toString());
f@0: 			builder.append(' ').append(cmd.getDiagram());
f@0: 			for(int i=0; i<cmd.getArgNum();i++){
f@0: 				builder.append(' ').append(cmd.getArgAt(i));
f@0: 			}
f@0: 			/* replace newlines for notes so that the log has them in one line only */
f@0: 			if(cmd.getName() == Command.Name.SET_NOTES){
f@0: 				InteractionLog.log("SERVER", action, CharEscaper.replaceNewline(builder.toString()));
f@0: 				return;
f@0: 			}
f@0: 			InteractionLog.log("SERVER", action, builder.toString());
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	public static Name valueOf(String n){
f@0: 		Name name = Name.NONE;
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: 	private Name name;
f@0: 	private Object[] args;
f@0: 	
f@0: 	public static enum Name implements Message.MessageName {
f@0: 		NONE,
f@0: 		LIST,
f@0: 		GET,
f@0: 		LOCAL,
f@0: 		INSERT_EDGE,
f@0: 		INSERT_NODE,
f@0: 		REMOVE_NODE,
f@0: 		REMOVE_EDGE,
f@0: 		SET_NODE_NAME,
f@0: 		SET_EDGE_NAME,
f@0: 		SET_PROPERTY,
f@0: 		SET_PROPERTIES,
f@0: 		CLEAR_PROPERTIES,
f@0: 		SET_NOTES,
f@0: 		ADD_PROPERTY,
f@0: 		REMOVE_PROPERTY,
f@0: 		SET_MODIFIERS,
f@0: 		SET_ENDDESCRIPTION,
f@0: 		SET_ENDLABEL,
f@0: 		TRANSLATE_NODE,
f@0: 		TRANSLATE_EDGE,
f@0: 		BEND,
f@0: 		STOP_EDGE_MOVE,
f@0: 		STOP_NODE_MOVE,
f@0: 		/**
f@0: 		 * not a proper command, only used for awareness on node selection for edge creation.
f@0: 		 */
f@0: 		SELECT_NODE_FOR_EDGE_CREATION,
f@0: 		/**
f@0: 		 * not a proper command, only used for awareness on node un-selection for edge creation.
f@0: 		 */
f@0: 		UNSELECT_NODE_FOR_EDGE_CREATION;
f@0: 	}	
f@0: }