Laboratoire ICAR » Plateforme TXM

 * it must also call the runInit method to allow the user to force stop the JobThread

package org.txm.rcp.editors;

import org.txm.core.results.TXMResult;

import org.txm.functions.Command;

/**

 * A command that opens an editor (which will computes the result).

 * 

 * The class adds a new mandatory member 'editor_id'

 * 

 * @author mdecorde

 *

 */

public class RCPCommand extends Command {

	public final String editor_id;

	public RCPCommand(Class<TXMResult> clazz, String editor_id) {

		super(clazz);

		this.editor_id = editor_id;

	}

	public RCPCommand(String cmd, Class<TXMResult> clazz, String editor_id) {

		super(cmd, clazz);

		this.editor_id = editor_id;

	}

	public String toString() {

		return super.toString()+" -> "+editor_id;

	}

	// 

}

package org.txm.rcp.editors;

import java.util.HashMap;

import org.eclipse.ui.PartInitException;

import org.txm.core.results.TXMResult;

import org.txm.functions.Command;

import org.txm.functions.CommandsAPI;

import org.txm.rcp.TXMWindows;

import org.txm.utils.logger.Log;

/**

 * Interface to call commands from a RCP plugin

 * 

 * @author mdecorde

 *

 */

public class RCPCommandsAPI extends CommandsAPI {

	/**

	 * @param cmd the command to call or the command to ope nwith the right editor

	 * @param parent the result parent

	 * @param parameters the parameters to compute the command or the parameters to set editor parameters with

	 * 

	 * @return A result or the editor's result. null if the command failed to compute  or to open editor. 

	 */

	public Object call(String cmd, TXMResult parent, HashMap<String, Object> parameters) {

		Command command = cmds.get(cmd);

		if (command == null) {

			System.out.println("No command found with name: "+cmd);

			return null;

		}

		if (command instanceof RCPCommand) {

			RCPCommand rcpcommand = (RCPCommand)command;

			if (rcpcommand.editor_id == null) {

				System.out.println("Failed to open editor: no context given.");

				return null;

			}

			// the editor will compute the command

			TXMResultEditorInput editorInput = new TXMResultEditorInput(parent, parameters);

			try {

				TXMEditorPart editor = (TXMEditorPart) TXMWindows.getActiveWindow().getActivePage()

						.openEditor(editorInput, rcpcommand.editor_id);

				if (editor.isReady()) {

					return editor;

				} else {

					System.out.println("Failed to open editor: internal error during initialisation.");

					return null;

				}

			} catch (PartInitException e) {

				System.out.println("Failed to open editor with "+cmd+" command and "+parameters+" parameters: "+e.getLocalizedMessage());

				Log.printStackTrace(e);

			}

			return null;

		} else {

			Object result = super.call(cmd, parent, parameters);

			System.out.println("Done: "+result);

			return result;

		}

	}

	//dans Handler.execute() RCPCommandsAPI.call("Concordance", params);

}

package org.txm.functions;

import java.util.HashMap;

import java.util.HashSet;

import org.txm.core.results.TXMResult;

import org.txm.utils.logger.Log;

/**

 * API to all knowned TXM commands.

 * 

 * Initialized during Toolbox initialisation using the TXMCommand extension point

 * 

 * For now a command is :

 * - an ID

 * - a TXMResult class

 * - a HashSet of mandatory parameter names (the commands must check itself the parameters class)

 * - a HashSet of optional parameter names (the commands must check itself the parameters class)

 * 

 * @author mdecorde

 *

 */

public class CommandsAPI {

	protected static final HashMap<String, Command> cmds = new HashMap<String, Command>();

	public static void install(String cmd, Class<TXMResult> clazz) {

		CommandsAPI.cmds.put(cmd, new Command(cmd,clazz));

	}

	/**

	 * Manually install a command

	 * 

	 * @param cmd

	 * @param clazz

	 * @param mandatory_parameters

	 */

	public static void install(Command command) {

		if (CommandsAPI.cmds.containsKey(command.cmd)) {

			Log.warning("The "+command.cmd+" command is already installed. Installing the new one: "+command);

		}

		CommandsAPI.cmds.put(command.cmd, command);

	}

	/**

	 * Manually install a command

	 * 

	 * @param cmd

	 * @param clazz

	 * @param mandatory_parameters

	 */

	public static void install(String cmd, Class<TXMResult> clazz, HashSet<String> mandatoryParameters) {

		Command command = new Command(cmd,clazz);

		command.mandatoryParameters.addAll(mandatoryParameters);

		CommandsAPI.cmds.put(cmd, command);

	}

	/**

	 * Manually install a command

	 * 

	 * @param cmd

	 * @param clazz

	 * @param mandatory_parameters

	 * @param optional_parameters

	 */

	public static void install(String cmd, Class<TXMResult> clazz, HashSet<String> mandatoryParameters, HashSet<String> optionalParameters) {

		Command command = new Command(cmd,clazz);

		command.mandatoryParameters.addAll(mandatoryParameters);

		command.optionalParameters.addAll(optionalParameters);

		CommandsAPI.cmds.put(cmd, command);

	}

	/**

	 * Manually uninstall a command

	 * 

	 * @param cmd

	 */

	public static void uninstall(String cmd) {

		CommandsAPI.cmds.remove(cmd);

	}

	public Object call(String cmd, TXMResult parent, HashMap<String, Object> parameters) {

		Command command = cmds.get(cmd);

		if (command == null) {

			System.out.println("No command found with name: "+cmd);

			return null;

		}

		// compute directly the command using the parameters 

		TXMResult result = null;

		try {

			if (command.mandatoryParameters.containsAll(parameters.keySet())) {

				System.out.println("Computing "+command.cmd+"...");

				result = command.clazz.newInstance();

				//result.compute(parameters);

				//System.out.println(result);

			} else {

				System.out.println("Failed to compute result with "+cmd+" command: missing some mandatory parameters: "+command.mandatoryParameters);

			}

		} catch (Exception e) {

			System.out.println("Failed to compute result with "+cmd+" command and "+parameters+" parameters: "+e.getLocalizedMessage());

			Log.printStackTrace(e);

		}

		return result;

	}

	// portail : ???

	// groovy : CommandsApi.call("Concordances", ["query":"Je|je]");

	// bash-like : compute Concordances query:"Je|je"

}

package org.txm.functions;

import java.util.HashSet;

import org.txm.core.results.TXMResult;

/**

 * Command description

 * 

 * @author mdecorde

 *

 */

public class Command {

	public final String cmd;

	public final Class<TXMResult> clazz;

	public final HashSet<String> mandatoryParameters = new HashSet<String>();

	public final HashSet<String> optionalParameters = new HashSet<String>();

	public Command(Class<TXMResult> clazz) {

		this.cmd = clazz.getSimpleName();

		this.clazz = clazz;

	}

	public Command(String cmd, Class<TXMResult> clazz) {

		this.cmd = cmd;

		this.clazz = clazz;

	}

	public String toString() {

		return cmd+" -> "+clazz.getSimpleName()+"("+mandatoryParameters+", "+optionalParameters+")";

	}

}

package org.txm.functions;

import java.util.ArrayList;

/**

 * Extension point used to declare new commands to the TXM core commands API

 * 

 * The plugin can add Command objects (like RCPCommand)

 * 

 * @author mdecorde

 *

 */

public abstract class CommandsAPIDeclaration {

	/**

	 * returns the Commands list to install

	 */

	public abstract ArrayList<Command> getCommandsList();

}

   <extension-point id="org.txm.commandapi" name="CommandAPI" schema="schema/org.txm.commandapi.exsd"/>

<?xml version='1.0' encoding='UTF-8'?>

<!-- Schema file written by PDE -->

<schema targetNamespace="org.txm.core" xmlns="http://www.w3.org/2001/XMLSchema">

<annotation>

      <appinfo>

         <meta.schema plugin="org.txm.core" id="org.txm.commandapi" name="CommandAPI"/>

      </appinfo>

      <documentation>

         use this extension point to declare new comamnds to the CommanddAPI

      </documentation>

   </annotation>

   <element name="extension">

      <annotation>

         <appinfo>

            <meta.element />

         </appinfo>

      </annotation>

      <complexType>

         <choice minOccurs="1" maxOccurs="unbounded">

            <element ref="CommandAPIDeclaration"/>

         </choice>

         <attribute name="point" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="id" type="string">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="name" type="string">

            <annotation>

               <documentation>

               </documentation>

               <appinfo>

                  <meta.attribute translatable="true"/>

               </appinfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <element name="CommandAPIDeclaration">

      <complexType>

         <attribute name="class" type="string">

            <annotation>

               <documentation>

               </documentation>

               <appinfo>

                  <meta.attribute kind="java" basedOn="org.txm.functions.CommandsAPIDeclaration:"/>

               </appinfo>

            </annotation>

         </attribute>

         <attribute name="name" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="description" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

               <appinfo>

                  <meta.attribute translatable="true"/>

               </appinfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <annotation>

      <appinfo>

         <meta.section type="since"/>

      </appinfo>

      <documentation>

         [Enter the first release in which this extension point appears.]

      </documentation>

   </annotation>

   <annotation>

      <appinfo>

         <meta.section type="examples"/>

      </appinfo>

      <documentation>

         [Enter extension point usage example here.]

      </documentation>

   </annotation>

   <annotation>

      <appinfo>

         <meta.section type="apiinfo"/>

      </appinfo>

      <documentation>

         [Enter API information here.]

      </documentation>

   </annotation>

   <annotation>

      <appinfo>

         <meta.section type="implementation"/>

      </appinfo>

      <documentation>

         [Enter information about supplied implementation of this extension point.]

      </documentation>

   </annotation>

</schema>