MATLABService supports MATLABCommands

MATLABService is now a SingletonService typed on MATLABCommands. It is
responsible for querying all MATLABCommands and creating appropriate
variables within MATLAB to access their utility methods.

Author: hinerm

src/main/java/org/scijava/plugins/scripting/matlab/DefaultMATLABService.java

@@ -31,29 +31,89 @@
 
 package org.scijava.plugins.scripting.matlab;
 
+import javax.script.ScriptEngine;
+
 import matlabcontrol.extensions.MatlabNumericArray;
 
+import org.scijava.log.LogService;
+import org.scijava.plugin.AbstractSingletonService;
 import org.scijava.plugin.Parameter;
 import org.scijava.plugin.Plugin;
 import org.scijava.script.ScriptService;
-import org.scijava.service.AbstractService;
 import org.scijava.service.Service;
 
 /**
+ * Default {@link MATLABService} implementation.
+ *
  * @author Mark Hiner
  */
 @Plugin(type = Service.class)
-public class DefaultMATLABService extends AbstractService implements
-	MATLABService
+public class DefaultMATLABService extends
+	AbstractSingletonService<MATLABCommands> implements MATLABService
 {
 
 	@Parameter
 	private ScriptService scriptService;
 
+	@Parameter
+	private LogService logService;
+
+	private boolean initializedCommands = false;
+
+	@Override
+	public String commandHelp() {
+		String helpMessage = "--- MATLAB Command Plugins ---\n\n";
+
+		for (final MATLABCommands command : getInstances()) {
+			helpMessage += command.usage();
+		}
+
+		helpMessage += "\n";
+
+		return helpMessage;
+	}
+
+	@Override
+	public void initializeCommands() {
+		if (!initializedCommands) createCommandVariables();
+	}
+
+	@Override
+	public void makeMATLABVariable(final String name, final Object value) {
+		final ScriptEngine engine =
+				scriptService.getLanguageByName("MATLAB").getScriptEngine();
+		engine.put(name, value);
+	}
+
 	// -- Service methods --
 
 	@Override
 	public void initialize() {
+		// Register known data type aliases for use in script @parameters
 		scriptService.addAlias("matrix", MatlabNumericArray.class);
 	}
+
+	// -- Typed methods --
+
+	@Override
+	public Class<MATLABCommands> getPluginType() {
+		return MATLABCommands.class;
+	}
+
+	// -- Helper methods --
+
+	/**
+	 * Helper method to create variables for each {@link MATLABCommands} within
+	 * MATLAB.
+	 */
+	private synchronized void createCommandVariables() {
+		if (!initializedCommands) {
+			for (final MATLABCommands command : getInstances()) {
+				final String name = command.getInfo().getName();
+
+				makeMATLABVariable(name, command);
+			}
+			initializedCommands = true;
+		}
+	}
 }

src/main/java/org/scijava/plugins/scripting/matlab/MATLABService.java

@@ -30,11 +30,45 @@
  */
 package org.scijava.plugins.scripting.matlab;
 
-import org.scijava.service.SciJavaService;
+import org.scijava.plugin.Plugin;
+import org.scijava.plugin.SingletonService;
+import org.scijava.service.Service;
 
 /**
+ * {@link Service} performing any utility operations required for MATLAB.
+ *
  * @author Mark Hiner
  */
-public interface MATLABService extends SciJavaService {
-// NB: No methods to declare
+public interface MATLABService extends SingletonService<MATLABCommands> {
+
+	/**
+	 * Builds a complete usage message by querying the
+	 * {@link MATLABCommands#usage()} method of all available commands.
+	 *
+	 * @return A formatted string of all available {@link MATLABCommands}.
+	 */
+	String commandHelp();
+
+	/**
+	 * Creates a MATLAB variable for each {@link MATLABCommands} plugin using the
+	 * {@link Plugin#name()} property as an identifier.
+	 * <p>
+	 * For example, if you create an {@code AwesomeMATLABCommands} class with
+	 * {@code name=FOO} and method {@code public void bar()}, after calling this
+	 * method you will be able to execute {@code FOO.bar} from within MATLAB.
+	 * </p>
+	 * <p>
+	 * NB: execution of this method requires a valid MATLAB installation.
+	 * </p>
+	 */
+	void initializeCommands();
+
+	/**
+	 * Attempts to create a variable in MATLAB with the give name and value.
+	 * <p>
+	 * NB: execution of this method should only be called from within a valid
+	 * MATLAB installation.
+	 * </p>
+	 */
+	void makeMATLABVariable(String name, Object value);
 }